- 0.68.0 (latest)
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder extends GeneratedMessageV3.Builder<StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder> implements StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilderSpecification 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.BuilderStatic 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 |
|
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 |
|
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 |
|
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 |
|
clone()
public StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder |
|
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 |
|
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 |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| 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 |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder |
|
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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
StreamAssistRequest.ToolsSpec.VertexAiSearchSpec.Builder |
|