Package com.google.cloud.datacatalog.v1beta1

Class SearchCatalogRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datacatalog.v1beta1.SearchCatalogRequest
All Implemented Interfaces:
SearchCatalogRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchCatalogRequest extends com.google.protobuf.GeneratedMessage implements SearchCatalogRequestOrBuilder
 Request message for
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchCatalogRequest.Builder
    Request message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
    static final class 
    SearchCatalogRequest.Scope
    The criteria that select the subspace used for query matching.
    static interface 
    SearchCatalogRequest.ScopeOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ORDER_BY_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    SCOPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SearchCatalogRequest
    getDefaultInstance()
     
    SearchCatalogRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getOrderBy()
    Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified * `default` that can only be descending If not specified, defaults to `relevance` descending.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified * `default` that can only be descending If not specified, defaults to `relevance` descending.
    int
    getPageSize()
    Number of results in the search page.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    com.google.protobuf.Parser<SearchCatalogRequest>
    getParserForType()
     
    String
    getQuery()
    Optional.
    com.google.protobuf.ByteString
    getQueryBytes()
    Optional.
    SearchCatalogRequest.Scope
    getScope()
    Required.
    SearchCatalogRequest.ScopeOrBuilder
    getScopeOrBuilder()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasScope()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchCatalogRequest.Builder
    newBuilder()
     
    static SearchCatalogRequest.Builder
    newBuilder(SearchCatalogRequest prototype)
     
    SearchCatalogRequest.Builder
    newBuilderForType()
     
    protected SearchCatalogRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchCatalogRequest
    parseDelimitedFrom(InputStream input)
     
    static SearchCatalogRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchCatalogRequest
    parseFrom(byte[] data)
     
    static SearchCatalogRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchCatalogRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchCatalogRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchCatalogRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchCatalogRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchCatalogRequest
    parseFrom(InputStream input)
     
    static SearchCatalogRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchCatalogRequest
    parseFrom(ByteBuffer data)
     
    static SearchCatalogRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchCatalogRequest>
    parser()
     
    SearchCatalogRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • hasScope

      public boolean hasScope()
       Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
      .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasScope in interface SearchCatalogRequestOrBuilder
      Returns:
      Whether the scope field is set.

    • getScope

      public SearchCatalogRequest.Scope getScope()
       Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
      .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getScope in interface SearchCatalogRequestOrBuilder
      Returns:
      The scope.

    • getScopeOrBuilder

      public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()
       Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
      .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getScopeOrBuilder in interface SearchCatalogRequestOrBuilder

    • getQuery

      public String getQuery()
       Optional. The query string in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface SearchCatalogRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Optional. The query string in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for query.

    • getPageSize

      public int getPageSize()
       Number of results in the search page. If <=0 then defaults to 10. Max limit
 for page_size is 1000. Throws an invalid argument for page_size > 1000.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface SearchCatalogRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. Pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface SearchCatalogRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getOrderBy

      public String getOrderBy()
       Specifies the ordering of results, currently supported case-sensitive
 choices are:

 * `relevance`, only supports descending
 * `last_modified_timestamp [asc|desc]`, defaults to descending if not
 specified
 * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
      string order_by = 5;
      Specified by:
      getOrderBy in interface SearchCatalogRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Specifies the ordering of results, currently supported case-sensitive
 choices are:

 * `relevance`, only supports descending
 * `last_modified_timestamp [asc|desc]`, defaults to descending if not
 specified
 * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • 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 SearchCatalogRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchCatalogRequest.Builder newBuilder()

    • newBuilder

      public static SearchCatalogRequest.Builder newBuilder(SearchCatalogRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchCatalogRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchCatalogRequest> 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 SearchCatalogRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder