Class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder (0.66.0)

public static final class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder extends GeneratedMessageV3.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addAllDataStoreSpecs(Iterable<? extends SearchRequest.DataStoreSpec> values)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec>
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

addDataStoreSpecs(SearchRequest.DataStoreSpec value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec value)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value SearchRequest.DataStoreSpec
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(SearchRequest.DataStoreSpec.Builder builderForValue)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue SearchRequest.DataStoreSpec.Builder
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value SearchRequest.DataStoreSpec
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue SearchRequest.DataStoreSpec.Builder
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

addDataStoreSpecsBuilder()

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchRequest.DataStoreSpec.Builder

addDataStoreSpecsBuilder(int index)

public SearchRequest.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

build()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec build()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

buildPartial()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec buildPartial()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

clear()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clear()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

clearDataStoreSpecs()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clearDataStoreSpecs()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

clone()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clone()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

getDataStoreSpecs(int index)

public SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec

getDataStoreSpecsBuilder(int index)

public SearchRequest.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec.Builder

getDataStoreSpecsBuilderList()

public List<SearchRequest.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getDataStoreSpecsCount()

public int getDataStoreSpecsCount()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDataStoreSpecsList()

public List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

public SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpecOrBuilder

getDataStoreSpecsOrBuilderList()

public List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpecOrBuilder>

getDefaultInstanceForType()

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec getDefaultInstanceForType()
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public 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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec other)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeFrom(StreamAssistRequest.ToolsSpec.VertexAiSearchSpec other)
Parameter
Name Description
other StreamAssistRequest.ToolsSpec.VertexAiSearchSpec
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

removeDataStoreSpecs(int index)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder removeDataStoreSpecs(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec value)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value SearchRequest.DataStoreSpec
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setDataStoreSpecs(int index, SearchRequest.DataStoreSpec.Builder builderForValue)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue SearchRequest.DataStoreSpec.Builder
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

setFilter(String value)

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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

This builder for chaining.

setFilterBytes(ByteString value)

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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder
Overrides