Package com.google.cloud.datacatalog.v1

Class SearchCatalogResult

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1.SearchCatalogResult
All Implemented Interfaces:
SearchCatalogResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchCatalogResult extends com.google.protobuf.GeneratedMessage implements SearchCatalogResultOrBuilder
 Result in the response to a search request.

 Each result captures details of one entry that matches the search.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogResult
See Also:

  • Field Details

    • SEARCH_RESULT_TYPE_FIELD_NUMBER

      public static final int SEARCH_RESULT_TYPE_FIELD_NUMBER
      See Also:

    • SEARCH_RESULT_SUBTYPE_FIELD_NUMBER

      public static final int SEARCH_RESULT_SUBTYPE_FIELD_NUMBER
      See Also:

    • RELATIVE_RESOURCE_NAME_FIELD_NUMBER

      public static final int RELATIVE_RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • LINKED_RESOURCE_FIELD_NUMBER

      public static final int LINKED_RESOURCE_FIELD_NUMBER
      See Also:

    • MODIFY_TIME_FIELD_NUMBER

      public static final int MODIFY_TIME_FIELD_NUMBER
      See Also:

    • INTEGRATED_SYSTEM_FIELD_NUMBER

      public static final int INTEGRATED_SYSTEM_FIELD_NUMBER
      See Also:

    • USER_SPECIFIED_SYSTEM_FIELD_NUMBER

      public static final int USER_SPECIFIED_SYSTEM_FIELD_NUMBER
      See Also:

    • FULLY_QUALIFIED_NAME_FIELD_NUMBER

      public static final int FULLY_QUALIFIED_NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSystemCase

      public SearchCatalogResult.SystemCase getSystemCase()
      Specified by:
      getSystemCase in interface SearchCatalogResultOrBuilder

    • getSearchResultTypeValue

      public 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;
      Specified by:
      getSearchResultTypeValue in interface SearchCatalogResultOrBuilder
      Returns:
      The enum numeric value on the wire for searchResultType.

    • getSearchResultType

      public 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;
      Specified by:
      getSearchResultType in interface SearchCatalogResultOrBuilder
      Returns:
      The searchResultType.

    • getSearchResultSubtype

      public 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;
      Specified by:
      getSearchResultSubtype in interface SearchCatalogResultOrBuilder
      Returns:
      The searchResultSubtype.

    • getSearchResultSubtypeBytes

      public 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;
      Specified by:
      getSearchResultSubtypeBytes in interface SearchCatalogResultOrBuilder
      Returns:
      The bytes for searchResultSubtype.

    • getRelativeResourceName

      public 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;
      Specified by:
      getRelativeResourceName in interface SearchCatalogResultOrBuilder
      Returns:
      The relativeResourceName.

    • getRelativeResourceNameBytes

      public 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;
      Specified by:
      getRelativeResourceNameBytes in interface SearchCatalogResultOrBuilder
      Returns:
      The bytes for relativeResourceName.

    • getLinkedResource

      public 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;
      Specified by:
      getLinkedResource in interface SearchCatalogResultOrBuilder
      Returns:
      The linkedResource.

    • getLinkedResourceBytes

      public 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;
      Specified by:
      getLinkedResourceBytes in interface SearchCatalogResultOrBuilder
      Returns:
      The bytes for linkedResource.

    • hasModifyTime

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

    • getModifyTime

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

    • getModifyTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getModifyTimeOrBuilder()
       The last modification timestamp of the entry in the source system.
      .google.protobuf.Timestamp modify_time = 7;
      Specified by:
      getModifyTimeOrBuilder in interface SearchCatalogResultOrBuilder

    • hasIntegratedSystem

      public 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];
      Specified by:
      hasIntegratedSystem in interface SearchCatalogResultOrBuilder
      Returns:
      Whether the integratedSystem field is set.

    • getIntegratedSystemValue

      public 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];
      Specified by:
      getIntegratedSystemValue in interface SearchCatalogResultOrBuilder
      Returns:
      The enum numeric value on the wire for integratedSystem.

    • getIntegratedSystem

      public 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];
      Specified by:
      getIntegratedSystem in interface SearchCatalogResultOrBuilder
      Returns:
      The integratedSystem.

    • hasUserSpecifiedSystem

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

    • getUserSpecifiedSystem

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

    • getUserSpecifiedSystemBytes

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

    • getFullyQualifiedName

      public 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;
      Specified by:
      getFullyQualifiedName in interface SearchCatalogResultOrBuilder
      Returns:
      The fullyQualifiedName.

    • getFullyQualifiedNameBytes

      public 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;
      Specified by:
      getFullyQualifiedNameBytes in interface SearchCatalogResultOrBuilder
      Returns:
      The bytes for fullyQualifiedName.

    • getDisplayName

      public String getDisplayName()
       The display name of the result.
      string display_name = 12;
      Specified by:
      getDisplayName in interface SearchCatalogResultOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

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

    • getDescription

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

    • getDescriptionBytes

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchCatalogResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchCatalogResult parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchCatalogResult parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchCatalogResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchCatalogResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchCatalogResult.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchCatalogResult.Builder newBuilder()

    • newBuilder

      public static SearchCatalogResult.Builder newBuilder(SearchCatalogResult prototype)

    • toBuilder

      public SearchCatalogResult.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchCatalogResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchCatalogResult getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchCatalogResult> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchCatalogResult> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchCatalogResult getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder