public static final class VertexAISearch.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder> implements VertexAISearchOrBuilder
Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builderProtobuf type
google.cloud.aiplatform.v1.VertexAISearch| Modifier and Type | Method and Description |
|---|---|
VertexAISearch.Builder |
addAllDataStoreSpecs(Iterable<? extends VertexAISearch.DataStoreSpec> values)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
addDataStoreSpecs(int index,
VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
addDataStoreSpecs(int index,
VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
addDataStoreSpecs(VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
addDataStoreSpecs(VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.DataStoreSpec.Builder |
addDataStoreSpecsBuilder()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.DataStoreSpec.Builder |
addDataStoreSpecsBuilder(int index)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
VertexAISearch |
build() |
VertexAISearch |
buildPartial() |
VertexAISearch.Builder |
clear() |
VertexAISearch.Builder |
clearDatastore()
Optional.
|
VertexAISearch.Builder |
clearDataStoreSpecs()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
clearEngine()
Optional.
|
VertexAISearch.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
VertexAISearch.Builder |
clearFilter()
Optional.
|
VertexAISearch.Builder |
clearMaxResults()
Optional.
|
VertexAISearch.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
VertexAISearch.Builder |
clone() |
String |
getDatastore()
Optional.
|
com.google.protobuf.ByteString |
getDatastoreBytes()
Optional.
|
VertexAISearch.DataStoreSpec |
getDataStoreSpecs(int index)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.DataStoreSpec.Builder |
getDataStoreSpecsBuilder(int index)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
List<VertexAISearch.DataStoreSpec.Builder> |
getDataStoreSpecsBuilderList()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
int |
getDataStoreSpecsCount()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
List<VertexAISearch.DataStoreSpec> |
getDataStoreSpecsList()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.DataStoreSpecOrBuilder |
getDataStoreSpecsOrBuilder(int index)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
List<? extends VertexAISearch.DataStoreSpecOrBuilder> |
getDataStoreSpecsOrBuilderList()
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getEngine()
Optional.
|
com.google.protobuf.ByteString |
getEngineBytes()
Optional.
|
String |
getFilter()
Optional.
|
com.google.protobuf.ByteString |
getFilterBytes()
Optional.
|
int |
getMaxResults()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
VertexAISearch.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
VertexAISearch.Builder |
mergeFrom(com.google.protobuf.Message other) |
VertexAISearch.Builder |
mergeFrom(VertexAISearch other) |
VertexAISearch.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
VertexAISearch.Builder |
removeDataStoreSpecs(int index)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
setDatastore(String value)
Optional.
|
VertexAISearch.Builder |
setDatastoreBytes(com.google.protobuf.ByteString value)
Optional.
|
VertexAISearch.Builder |
setDataStoreSpecs(int index,
VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
setDataStoreSpecs(int index,
VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along
with configurations for those data stores.
|
VertexAISearch.Builder |
setEngine(String value)
Optional.
|
VertexAISearch.Builder |
setEngineBytes(com.google.protobuf.ByteString value)
Optional.
|
VertexAISearch.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
VertexAISearch.Builder |
setFilter(String value)
Optional.
|
VertexAISearch.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Optional.
|
VertexAISearch.Builder |
setMaxResults(int value)
Optional.
|
VertexAISearch.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
VertexAISearch.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic VertexAISearch build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic VertexAISearch buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic VertexAISearch.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexAISearch.Builder>public VertexAISearch.Builder mergeFrom(VertexAISearch other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public VertexAISearch.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexAISearch.Builder>IOExceptionpublic String getDatastore()
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];getDatastore in interface VertexAISearchOrBuilderpublic com.google.protobuf.ByteString getDatastoreBytes()
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];getDatastoreBytes in interface VertexAISearchOrBuilderpublic VertexAISearch.Builder setDatastore(String value)
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];value - The datastore to set.public VertexAISearch.Builder clearDatastore()
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];public VertexAISearch.Builder setDatastoreBytes(com.google.protobuf.ByteString value)
Optional. Fully-qualified Vertex AI Search data store resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for datastore to set.public String getEngine()
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];getEngine in interface VertexAISearchOrBuilderpublic com.google.protobuf.ByteString getEngineBytes()
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];getEngineBytes in interface VertexAISearchOrBuilderpublic VertexAISearch.Builder setEngine(String value)
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];value - The engine to set.public VertexAISearch.Builder clearEngine()
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];public VertexAISearch.Builder setEngineBytes(com.google.protobuf.ByteString value)
Optional. Fully-qualified Vertex AI Search engine resource ID.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
string engine = 2 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for engine to set.public int getMaxResults()
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];getMaxResults in interface VertexAISearchOrBuilderpublic VertexAISearch.Builder setMaxResults(int value)
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];value - The maxResults to set.public VertexAISearch.Builder clearMaxResults()
Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];public String getFilter()
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];getFilter in interface VertexAISearchOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];getFilterBytes in interface VertexAISearchOrBuilderpublic VertexAISearch.Builder setFilter(String value)
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];value - The filter to set.public VertexAISearch.Builder clearFilter()
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];public VertexAISearch.Builder setFilterBytes(com.google.protobuf.ByteString value)
Optional. Filter strings to be passed to the search API.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for filter to set.public List<VertexAISearch.DataStoreSpec> getDataStoreSpecsList()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
getDataStoreSpecsList in interface VertexAISearchOrBuilderpublic int getDataStoreSpecsCount()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
getDataStoreSpecsCount in interface VertexAISearchOrBuilderpublic VertexAISearch.DataStoreSpec getDataStoreSpecs(int index)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
getDataStoreSpecs in interface VertexAISearchOrBuilderpublic VertexAISearch.Builder setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder setDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder addDataStoreSpecs(VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec value)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder addDataStoreSpecs(VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder addDataStoreSpecs(int index, VertexAISearch.DataStoreSpec.Builder builderForValue)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder addAllDataStoreSpecs(Iterable<? extends VertexAISearch.DataStoreSpec> values)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder clearDataStoreSpecs()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.Builder removeDataStoreSpecs(int index)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.DataStoreSpec.Builder getDataStoreSpecsBuilder(int index)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
getDataStoreSpecsOrBuilder in interface VertexAISearchOrBuilderpublic List<? extends VertexAISearch.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
getDataStoreSpecsOrBuilderList in interface VertexAISearchOrBuilderpublic VertexAISearch.DataStoreSpec.Builder addDataStoreSpecsBuilder()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public VertexAISearch.DataStoreSpec.Builder addDataStoreSpecsBuilder(int index)
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public List<VertexAISearch.DataStoreSpec.Builder> getDataStoreSpecsBuilderList()
Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;
public final VertexAISearch.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>public final VertexAISearch.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<VertexAISearch.Builder>Copyright © 2025 Google LLC. All rights reserved.