Class: Google::Cloud::DataCatalog::V1::SearchCatalogResult

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/search.rb

Overview

Result in the response to a search request.

Each result captures details of one entry that matches the search.

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Entry description that can consist of several sentences or paragraphs that describe entry contents.

Returns:

  • (::String) —

    Entry description that can consist of several sentences or paragraphs that describe entry contents.



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns The display name of the result.

Returns:

  • (::String) —

    The display name of the result.



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#fully_qualified_name ⇒ ::String

Returns Fully qualified name (FQN) of the resource.

FQNs take two forms:

  • For non-regionalized resources:

{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

  • For regionalized resources:

{SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

Example for a DPMS table:

dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID.

Returns:

  • (::String) —

    Fully qualified name (FQN) of the resource.

    FQNs take two forms:

    • For non-regionalized resources:

    {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    • For regionalized resources:

    {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Example for a DPMS table:

    dataproc_metastore:PROJECT_ID.LOCATION_ID.INSTANCE_ID.DATABASE_ID.TABLE_ID



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#integrated_system ⇒ ::Google::Cloud::DataCatalog::V1::IntegratedSystem (readonly)

Returns Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

Returns:



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#linked_resource ⇒ ::String

Returns The full name of the Google Cloud resource the entry belongs to.

For more information, see Full Resource Name.

Example:

//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID.

Returns:

  • (::String) —

    The full name of the Google Cloud resource the entry belongs to.

    For more information, see Full Resource Name.

    Example:

    //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#modify_time ⇒ ::Google::Protobuf::Timestamp

Returns The last modification timestamp of the entry in the source system.

Returns:



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#relative_resource_name ⇒ ::String

Returns The relative name of the resource in URL format.

Examples:

  • projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
  • projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}.

Returns:

  • (::String) —

    The relative name of the resource in URL format.

    Examples:

    • projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
    • projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}


93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#search_result_subtype ⇒ ::String

Returns Sub-type of the search result.

A dot-delimited full type of the resource. The same type you specify in the type search predicate.

Examples: entry.table, entry.dataStream, tagTemplate.

Returns:

  • (::String) —

    Sub-type of the search result.

    A dot-delimited full type of the resource. The same type you specify in the type search predicate.

    Examples: entry.table, entry.dataStream, tagTemplate.



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#search_result_type ⇒ ::Google::Cloud::DataCatalog::V1::SearchResultType

Returns Type of the search result.

You can use this field to determine which get method to call to fetch the full resource.

Returns:



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_specified_system ⇒ ::String

Returns Custom source system that you can manually integrate Data Catalog with.

Returns:

  • (::String) —

    Custom source system that you can manually integrate Data Catalog with.



93
94
95
96
 
# File 'proto_docs/google/cloud/datacatalog/v1/search.rb', line 93

class SearchCatalogResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end