com.google.cloud.aiplatform.v1

Class VertexAISearch.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<VertexAISearch.Builder>

com.google.cloud.aiplatform.v1.VertexAISearch.Builder

All Implemented Interfaces:

VertexAISearchOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

VertexAISearch

public static final class VertexAISearch.Builder
extends com.google.protobuf.GeneratedMessage.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-builder
 

Protobuf type google.cloud.aiplatform.v1.VertexAISearch

Method Summary

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	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	clearFilter() Optional.
VertexAISearch.Builder	clearMaxResults() Optional.
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.GeneratedMessage.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	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	setFilter(String value) Optional.
VertexAISearch.Builder	setFilterBytes(com.google.protobuf.ByteString value) Optional.
VertexAISearch.Builder	setMaxResults(int value) Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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<VertexAISearch.Builder>

clear

public VertexAISearch.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<VertexAISearch.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<VertexAISearch.Builder>

getDefaultInstanceForType

public VertexAISearch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public VertexAISearch build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public VertexAISearch buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public VertexAISearch.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<VertexAISearch.Builder>

mergeFrom

public VertexAISearch.Builder mergeFrom(VertexAISearch other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<VertexAISearch.Builder>

mergeFrom

public VertexAISearch.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<VertexAISearch.Builder>

Throws:

IOException

getDatastore

public 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];

Specified by:

getDatastore in interface VertexAISearchOrBuilder

Returns:

The datastore.

getDatastoreBytes

public 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];

Specified by:

getDatastoreBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for datastore.

setDatastore

public 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];

Parameters:

value - The datastore to set.

Returns:

This builder for chaining.

clearDatastore

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];

Returns:

This builder for chaining.

setDatastoreBytes

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];

Parameters:

value - The bytes for datastore to set.

Returns:

This builder for chaining.

getEngine

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];

Specified by:

getEngine in interface VertexAISearchOrBuilder

Returns:

The engine.

getEngineBytes

public 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];

Specified by:

getEngineBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for engine.

setEngine

public 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];

Parameters:

value - The engine to set.

Returns:

This builder for chaining.

clearEngine

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];

Returns:

This builder for chaining.

setEngineBytes

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];

Parameters:

value - The bytes for engine to set.

Returns:

This builder for chaining.

getMaxResults

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];

Specified by:

getMaxResults in interface VertexAISearchOrBuilder

Returns:

The maxResults.

setMaxResults

public 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];

Parameters:

value - The maxResults to set.

Returns:

This builder for chaining.

clearMaxResults

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];

Returns:

This builder for chaining.

getFilter

public String getFilter()

 Optional. Filter strings to be passed to the search API.
 

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

Specified by:

getFilter in interface VertexAISearchOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter strings to be passed to the search API.
 

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

Specified by:

getFilterBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for filter.

setFilter

public VertexAISearch.Builder setFilter(String value)

 Optional. Filter strings to be passed to the search API.
 

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public VertexAISearch.Builder clearFilter()

 Optional. Filter strings to be passed to the search API.
 

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

Returns:

This builder for chaining.

setFilterBytes

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];

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getDataStoreSpecsList

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;

Specified by:

getDataStoreSpecsList in interface VertexAISearchOrBuilder

getDataStoreSpecsCount

public 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;

Specified by:

getDataStoreSpecsCount in interface VertexAISearchOrBuilder

getDataStoreSpecs

public 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;

Specified by:

getDataStoreSpecs in interface VertexAISearchOrBuilder

setDataStoreSpecs

public 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;

setDataStoreSpecs

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;

addDataStoreSpecs

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;

addDataStoreSpecs

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;

addDataStoreSpecs

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;

addDataStoreSpecs

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;

addAllDataStoreSpecs

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;

clearDataStoreSpecs

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;

removeDataStoreSpecs

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;

getDataStoreSpecsBuilder

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;

getDataStoreSpecsOrBuilder

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;

Specified by:

getDataStoreSpecsOrBuilder in interface VertexAISearchOrBuilder

getDataStoreSpecsOrBuilderList

public 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;

Specified by:

getDataStoreSpecsOrBuilderList in interface VertexAISearchOrBuilder

addDataStoreSpecsBuilder

public 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;

addDataStoreSpecsBuilder

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;

getDataStoreSpecsBuilderList

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;