Package com.google.cloud.datacatalog.v1

Interface SearchCatalogResultOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchCatalogResult, SearchCatalogResult.Builder
@Generated public interface SearchCatalogResultOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSearchResultTypeValue

      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:
      The enum numeric value on the wire for searchResultType.

    • getSearchResultType

      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:
      The searchResultType.

    • getSearchResultSubtype

      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:
      The searchResultSubtype.

    • getSearchResultSubtypeBytes

      com.google.protobuf.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:
      The bytes for searchResultSubtype.

    • getRelativeResourceName

      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:
      The relativeResourceName.

    • getRelativeResourceNameBytes

      com.google.protobuf.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:
      The bytes for relativeResourceName.

    • getLinkedResource

      String getLinkedResource()
       The full name of the Google Cloud resource the entry belongs to.

 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).

 Example:

 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
      string linked_resource = 4;
      Returns:
      The linkedResource.

    • getLinkedResourceBytes

      com.google.protobuf.ByteString getLinkedResourceBytes()
       The full name of the Google Cloud resource the entry belongs to.

 For more information, see [Full Resource Name]
 (/apis/design/resource_names#full_resource_name).

 Example:

 `//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`
      string linked_resource = 4;
      Returns:
      The bytes for linkedResource.

    • hasModifyTime

      boolean hasModifyTime()
       The last modification timestamp of the entry in the source system.
      .google.protobuf.Timestamp modify_time = 7;
      Returns:
      Whether the modifyTime field is set.

    • getModifyTime

      com.google.protobuf.Timestamp getModifyTime()
       The last modification timestamp of the entry in the source system.
      .google.protobuf.Timestamp modify_time = 7;
      Returns:
      The modifyTime.

    • getModifyTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getModifyTimeOrBuilder()
       The last modification timestamp of the entry in the source system.
      .google.protobuf.Timestamp modify_time = 7;

    • hasIntegratedSystem

      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:
      Whether the integratedSystem field is set.

    • getIntegratedSystemValue

      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:
      The enum numeric value on the wire for integratedSystem.

    • getIntegratedSystem

      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:
      The integratedSystem.

    • hasUserSpecifiedSystem

      boolean hasUserSpecifiedSystem()
       Custom source system that you can manually integrate Data Catalog with.
      string user_specified_system = 9;
      Returns:
      Whether the userSpecifiedSystem field is set.

    • getUserSpecifiedSystem

      String getUserSpecifiedSystem()
       Custom source system that you can manually integrate Data Catalog with.
      string user_specified_system = 9;
      Returns:
      The userSpecifiedSystem.

    • getUserSpecifiedSystemBytes

      com.google.protobuf.ByteString getUserSpecifiedSystemBytes()
       Custom source system that you can manually integrate Data Catalog with.
      string user_specified_system = 9;
      Returns:
      The bytes for userSpecifiedSystem.

    • getFullyQualifiedName

      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:
      The fullyQualifiedName.

    • getFullyQualifiedNameBytes

      com.google.protobuf.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:
      The bytes for fullyQualifiedName.

    • getDisplayName

      String getDisplayName()
       The display name of the result.
      string display_name = 12;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the result.
      string display_name = 12;
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Entry description that can consist of several sentences or paragraphs that
 describe entry contents.
      string description = 13;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Entry description that can consist of several sentences or paragraphs that
 describe entry contents.
      string description = 13;
      Returns:
      The bytes for description.

    • getSystemCase

      SearchCatalogResult.SystemCase getSystemCase()