Package com.google.cloud.dataplex.v1

Class SearchEntriesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.SearchEntriesRequest
All Implemented Interfaces:
SearchEntriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchEntriesRequest extends com.google.protobuf.GeneratedMessage implements SearchEntriesRequestOrBuilder
Protobuf type google.cloud.dataplex.v1.SearchEntriesRequest
See Also:

  • 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

    • getName

      public String getName()
       Required. The project to which the request should be attributed in the
 following form: `projects/{project}/locations/global`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface SearchEntriesRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The project to which the request should be attributed in the
 following form: `projects/{project}/locations/global`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface SearchEntriesRequestOrBuilder
      Returns:
      The bytes for name.

    • getQuery

      public String getQuery()
       Required. The query against which entries in scope should be matched.
 The query syntax is defined in [Search syntax for Dataplex Universal
 Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface SearchEntriesRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Required. The query against which entries in scope should be matched.
 The query syntax is defined in [Search syntax for Dataplex Universal
 Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryBytes in interface SearchEntriesRequestOrBuilder
      Returns:
      The bytes for query.

    • getPageSize

      public int getPageSize()
       Optional. 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 = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface SearchEntriesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. Page token received from a previous `SearchEntries` call. Provide
 this to retrieve the subsequent page.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface SearchEntriesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `SearchEntries` call. Provide
 this to retrieve the subsequent page.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface SearchEntriesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getOrderBy

      public String getOrderBy()
       Optional. Specifies the ordering of results.
 Supported values are:

 * `relevance`
 * `last_modified_timestamp`
 * `last_modified_timestamp asc`
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderBy in interface SearchEntriesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Optional. Specifies the ordering of results.
 Supported values are:

 * `relevance`
 * `last_modified_timestamp`
 * `last_modified_timestamp asc`
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOrderByBytes in interface SearchEntriesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • getScope

      public String getScope()
       Optional. The scope under which the search should be operating. It must
 either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
 unspecified, it defaults to the organization where the project provided in
 `name` is located.
      string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScope in interface SearchEntriesRequestOrBuilder
      Returns:
      The scope.

    • getScopeBytes

      public com.google.protobuf.ByteString getScopeBytes()
       Optional. The scope under which the search should be operating. It must
 either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
 unspecified, it defaults to the organization where the project provided in
 `name` is located.
      string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScopeBytes in interface SearchEntriesRequestOrBuilder
      Returns:
      The bytes for scope.

    • getSemanticSearch

      public boolean getSemanticSearch()
       Optional. Specifies whether the search should understand the meaning and
 intent behind the query, rather than just matching keywords.
      bool semantic_search = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSemanticSearch in interface SearchEntriesRequestOrBuilder
      Returns:
      The semanticSearch.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchEntriesRequest.Builder newBuilder()

    • newBuilder

      public static SearchEntriesRequest.Builder newBuilder(SearchEntriesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchEntriesRequest getDefaultInstance()

    • parser

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

    • getParserForType

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