Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::SearchCatalogResult (v0.23.0)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::SearchCatalogResult.

Result in the response to a search request.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String

Returns

(::String) — Entry description that can consist of several sentences or paragraphs that describe entry contents.

#description=

def description=(value) -> ::String

Parameter

value (::String) — 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.

#display_name

def display_name() -> ::String

Returns

(::String) — The display name of the result.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — The display name of the result.

Returns

(::String) — The display name of the result.

#fully_qualified_name

def fully_qualified_name() -> ::String

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

#fully_qualified_name=

def fully_qualified_name=(value) -> ::String

Parameter

value (::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

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

#integrated_system

def integrated_system() -> ::Google::Cloud::DataCatalog::V1::IntegratedSystem

Returns

(::Google::Cloud::DataCatalog::V1::IntegratedSystem) — Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.

#linked_resource

def linked_resource() -> ::String

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

#linked_resource=

def linked_resource=(value) -> ::String

Parameter

value (::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

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

#modify_time

def modify_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — The last modification timestamp of the entry in the source system.

#modify_time=

def modify_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — The last modification timestamp of the entry in the source system.

Returns

(::Google::Protobuf::Timestamp) — The last modification timestamp of the entry in the source system.

#relative_resource_name

def relative_resource_name() -> ::String

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}

#relative_resource_name=

def relative_resource_name=(value) -> ::String

Parameter

value (::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}

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}

#search_result_subtype

def search_result_subtype() -> ::String

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.

#search_result_subtype=

def search_result_subtype=(value) -> ::String

Parameter

value (::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.

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.

#search_result_type

def search_result_type() -> ::Google::Cloud::DataCatalog::V1::SearchResultType

Returns

(::Google::Cloud::DataCatalog::V1::SearchResultType) — Type of the search result.

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

#search_result_type=

def search_result_type=(value) -> ::Google::Cloud::DataCatalog::V1::SearchResultType

Parameter

value (::Google::Cloud::DataCatalog::V1::SearchResultType) — Type of the search result.

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

Returns

(::Google::Cloud::DataCatalog::V1::SearchResultType) — Type of the search result.

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

#user_specified_system

def user_specified_system() -> ::String

Returns

(::String) — Custom source system that you can manually integrate Data Catalog with.

#user_specified_system=

def user_specified_system=(value) -> ::String

Parameter

value (::String) — Custom source system that you can manually integrate Data Catalog with.

Returns

(::String) — Custom source system that you can manually integrate Data Catalog with.