Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest.DataStoreSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.DataStoreSpec.Builder>
com.google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec.Builder
All Implemented Interfaces:
SearchRequest.DataStoreSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest.DataStoreSpec
public static final class SearchRequest.DataStoreSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.DataStoreSpec.Builder> implements SearchRequest.DataStoreSpecOrBuilder
 A struct to define data stores to filter on in a search call and
 configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
 error is returned.
Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec

  • 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<SearchRequest.DataStoreSpec.Builder>

    • clear

      public SearchRequest.DataStoreSpec.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<SearchRequest.DataStoreSpec.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<SearchRequest.DataStoreSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchRequest.DataStoreSpec.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<SearchRequest.DataStoreSpec.Builder>

    • mergeFrom

      public SearchRequest.DataStoreSpec.Builder mergeFrom(SearchRequest.DataStoreSpec other)

    • isInitialized

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

    • mergeFrom

      public SearchRequest.DataStoreSpec.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<SearchRequest.DataStoreSpec.Builder>
      Throws:
      IOException

    • getDataStore

      public String getDataStore()
       Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDataStore in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      The dataStore.

    • getDataStoreBytes

      public com.google.protobuf.ByteString getDataStoreBytes()
       Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getDataStoreBytes in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      The bytes for dataStore.

    • setDataStore

      public SearchRequest.DataStoreSpec.Builder setDataStore(String value)
       Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The dataStore to set.
      Returns:
      This builder for chaining.

    • clearDataStore

      public SearchRequest.DataStoreSpec.Builder clearDataStore()
       Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setDataStoreBytes

      public SearchRequest.DataStoreSpec.Builder setDataStoreBytes(com.google.protobuf.ByteString value)
       Required. Full resource name of
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
 `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
 The path must include the project number, project id is not supported for
 this field.
      string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for dataStore to set.
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public SearchRequest.DataStoreSpec.Builder setFilter(String value)
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public SearchRequest.DataStoreSpec.Builder clearFilter()
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setFilterBytes

      public SearchRequest.DataStoreSpec.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Optional. Filter specification to filter documents in the data store
 specified by data_store field. For more information on filtering, see
 [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • hasBoostSpec

      public boolean hasBoostSpec()
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoostSpec in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public SearchRequest.BoostSpec getBoostSpec()
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpec in interface SearchRequest.DataStoreSpecOrBuilder
      Returns:
      The boostSpec.

    • setBoostSpec

      public SearchRequest.DataStoreSpec.Builder setBoostSpec(SearchRequest.BoostSpec value)
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setBoostSpec

      public SearchRequest.DataStoreSpec.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeBoostSpec

      public SearchRequest.DataStoreSpec.Builder mergeBoostSpec(SearchRequest.BoostSpec value)
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearBoostSpec

      public SearchRequest.DataStoreSpec.Builder clearBoostSpec()
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostSpecBuilder

      public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostSpecOrBuilder

      public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Optional. Boost specification to boost certain documents.
 For more information on boosting, see
 [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
      .google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpecOrBuilder in interface SearchRequest.DataStoreSpecOrBuilder