Package com.google.cloud.dataplex.v1

Class SearchEntriesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchEntriesRequest.Builder>
com.google.cloud.dataplex.v1.SearchEntriesRequest.Builder
All Implemented Interfaces:
SearchEntriesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchEntriesRequest
public static final class SearchEntriesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchEntriesRequest.Builder> implements SearchEntriesRequestOrBuilder
Protobuf type google.cloud.dataplex.v1.SearchEntriesRequest

  • 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.Builder<SearchEntriesRequest.Builder>

    • clear

      public SearchEntriesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchEntriesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchEntriesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchEntriesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchEntriesRequest.Builder>

    • mergeFrom

      public SearchEntriesRequest.Builder mergeFrom(SearchEntriesRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchEntriesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchEntriesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public SearchEntriesRequest.Builder setName(String value)
       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) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public SearchEntriesRequest.Builder clearName()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setNameBytes

      public SearchEntriesRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setQuery

      public SearchEntriesRequest.Builder setQuery(String value)
       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];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchEntriesRequest.Builder clearQuery()
       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];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchEntriesRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public SearchEntriesRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchEntriesRequest.Builder clearPageSize()
       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];
      Returns:
      This builder for chaining.

    • 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.

    • setPageToken

      public SearchEntriesRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchEntriesRequest.Builder clearPageToken()
       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];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchEntriesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setOrderBy

      public SearchEntriesRequest.Builder setOrderBy(String value)
       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];
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public SearchEntriesRequest.Builder clearOrderBy()
       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];
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public SearchEntriesRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • 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.

    • setScope

      public SearchEntriesRequest.Builder setScope(String value)
       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];
      Parameters:
      value - The scope to set.
      Returns:
      This builder for chaining.

    • clearScope

      public SearchEntriesRequest.Builder clearScope()
       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];
      Returns:
      This builder for chaining.

    • setScopeBytes

      public SearchEntriesRequest.Builder setScopeBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for scope to set.
      Returns:
      This builder for chaining.

    • 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.

    • setSemanticSearch

      public SearchEntriesRequest.Builder setSemanticSearch(boolean value)
       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];
      Parameters:
      value - The semanticSearch to set.
      Returns:
      This builder for chaining.

    • clearSemanticSearch

      public SearchEntriesRequest.Builder clearSemanticSearch()
       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];
      Returns:
      This builder for chaining.