Interface SearchCatalogResultOrBuilder (1.26.0)

public interface SearchCatalogResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

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

string description = 13;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 13;

Returns
Type	Description
`ByteString`	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

The display name of the result.

string display_name = 12;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of the result.

string display_name = 12;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getFullyQualifiedName()

public abstract String getFullyQualifiedName()

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

string fully_qualified_name = 10;

Returns
Type	Description
`String`	The fullyQualifiedName.

getFullyQualifiedNameBytes()

public abstract ByteString getFullyQualifiedNameBytes()

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

string fully_qualified_name = 10;

Returns
Type	Description
`ByteString`	The bytes for fullyQualifiedName.

getIntegratedSystem()

public abstract IntegratedSystem getIntegratedSystem()

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

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`IntegratedSystem`	The integratedSystem.

getIntegratedSystemValue()

public abstract int getIntegratedSystemValue()

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

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The enum numeric value on the wire for integratedSystem.

getLinkedResource()

public abstract String getLinkedResource()

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

string linked_resource = 4;

Returns
Type	Description
`String`	The linkedResource.

getLinkedResourceBytes()

public abstract ByteString getLinkedResourceBytes()

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

string linked_resource = 4;

Returns
Type	Description
`ByteString`	The bytes for linkedResource.

getModifyTime()

public abstract Timestamp getModifyTime()

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

.google.protobuf.Timestamp modify_time = 7;

Returns
Type	Description
`Timestamp`	The modifyTime.

getModifyTimeOrBuilder()

public abstract TimestampOrBuilder getModifyTimeOrBuilder()

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

.google.protobuf.Timestamp modify_time = 7;

Returns
Type	Description
`TimestampOrBuilder`

getRelativeResourceName()

public abstract String getRelativeResourceName()

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}

string relative_resource_name = 3;

Returns
Type	Description
`String`	The relativeResourceName.

getRelativeResourceNameBytes()

public abstract ByteString getRelativeResourceNameBytes()

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}

string relative_resource_name = 3;

Returns
Type	Description
`ByteString`	The bytes for relativeResourceName.

getSearchResultSubtype()

public abstract String getSearchResultSubtype()

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.

string search_result_subtype = 2;

Returns
Type	Description
`String`	The searchResultSubtype.

getSearchResultSubtypeBytes()

public abstract ByteString getSearchResultSubtypeBytes()

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.

string search_result_subtype = 2;

Returns
Type	Description
`ByteString`	The bytes for searchResultSubtype.

getSearchResultType()

public abstract SearchResultType getSearchResultType()

Type of the search result.

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

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Returns
Type	Description
`SearchResultType`	The searchResultType.

getSearchResultTypeValue()

public abstract int getSearchResultTypeValue()

Type of the search result.

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

.google.cloud.datacatalog.v1.SearchResultType search_result_type = 1;

Returns
Type	Description
`int`	The enum numeric value on the wire for searchResultType.

getSystemCase()

public abstract SearchCatalogResult.SystemCase getSystemCase()

Returns
Type	Description
`SearchCatalogResult.SystemCase`

getUserSpecifiedSystem()

public abstract String getUserSpecifiedSystem()

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

string user_specified_system = 9;

Returns
Type	Description
`String`	The userSpecifiedSystem.

getUserSpecifiedSystemBytes()

public abstract ByteString getUserSpecifiedSystemBytes()

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

string user_specified_system = 9;

Returns
Type	Description
`ByteString`	The bytes for userSpecifiedSystem.

hasIntegratedSystem()

public abstract boolean hasIntegratedSystem()

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

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the integratedSystem field is set.

hasModifyTime()

public abstract boolean hasModifyTime()

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

.google.protobuf.Timestamp modify_time = 7;

Returns
Type	Description
`boolean`	Whether the modifyTime field is set.

hasUserSpecifiedSystem()

public abstract boolean hasUserSpecifiedSystem()

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

string user_specified_system = 9;

Returns
Type	Description
`boolean`	Whether the userSpecifiedSystem field is set.