Package com.google.cloud.discoveryengine.v1

Class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder>
com.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
All Implemented Interfaces:
StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
public static final class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder> implements StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder
 Specification of the Vertex AI Search tool.
Protobuf type google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

  • 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<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder>

    • clear

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.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<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.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<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder>

    • getDefaultInstanceForType

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.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<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder>

    • mergeFrom

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeFrom(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec other)

    • isInitialized

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

    • mergeFrom

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.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<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder>
      Throws:
      IOException

    • getDataStoreSpecsList

      public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreSpecsList in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

    • getDataStoreSpecsCount

      public int getDataStoreSpecsCount()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreSpecsCount in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

    • getDataStoreSpecs

      public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreSpecs in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

    • setDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addAllDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clearDataStoreSpecs()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • removeDataStoreSpecs

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder removeDataStoreSpecs(int index)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDataStoreSpecsOrBuilder

      public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreSpecsOrBuilder in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

    • getDataStoreSpecsOrBuilderList

      public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreSpecsOrBuilderList in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder

    • addDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • addDataStoreSpecsBuilder

      public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDataStoreSpecsBuilderList

      public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()
       Optional. Specs defining
 [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
 a search call and configurations for those data stores. This is only
 considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
 multiple data stores.
      repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getFilter

      public String getFilter()
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the documents being
 filtered. Filter expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the documents being
 filtered. Filter expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setFilter(String value)
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the documents being
 filtered. Filter expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clearFilter()
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the documents being
 filtered. Filter expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setFilterBytes

      public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Optional. The filter syntax consists of an expression language for
 constructing a predicate from one or more fields of the documents being
 filtered. Filter expression is case-sensitive.

 If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.

 Filtering in Vertex AI Search is done by mapping the LHS filter key to
 a key property defined in the Vertex AI Search backend -- this mapping
 is defined by the customer in their schema. For example a media
 customer might have a field 'name' in their schema. In this case the
 filter would look like this: filter --> name:'ANY("king kong")'

 For more information about filtering including syntax and filter
 operators, see
 [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.