Class DataStoreTool.Builder (0.1.0)

public static final class DataStoreTool.Builder extends GeneratedMessage.Builder<DataStoreTool.Builder> implements DataStoreToolOrBuilder

Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Protobuf type google.cloud.ces.v1.DataStoreTool

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DataStoreTool.Builder

Implements

DataStoreToolOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllBoostSpecs(Iterable<? extends DataStoreTool.BoostSpecs> values)

public DataStoreTool.Builder addAllBoostSpecs(Iterable<? extends DataStoreTool.BoostSpecs> values)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.ces.v1.DataStoreTool.BoostSpecs>

Returns
Type	Description
DataStoreTool.Builder

addAllModalityConfigs(Iterable<? extends DataStoreTool.ModalityConfig> values)

public DataStoreTool.Builder addAllModalityConfigs(Iterable<? extends DataStoreTool.ModalityConfig> values)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.ces.v1.DataStoreTool.ModalityConfig>

Returns
Type	Description
DataStoreTool.Builder

addBoostSpecs(DataStoreTool.BoostSpecs value)

public DataStoreTool.Builder addBoostSpecs(DataStoreTool.BoostSpecs value)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.BoostSpecs

Returns
Type	Description
DataStoreTool.Builder

addBoostSpecs(DataStoreTool.BoostSpecs.Builder builderForValue)

public DataStoreTool.Builder addBoostSpecs(DataStoreTool.BoostSpecs.Builder builderForValue)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DataStoreTool.BoostSpecs.Builder

Returns
Type	Description
DataStoreTool.Builder

addBoostSpecs(int index, DataStoreTool.BoostSpecs value)

public DataStoreTool.Builder addBoostSpecs(int index, DataStoreTool.BoostSpecs value)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataStoreTool.BoostSpecs

Returns
Type	Description
DataStoreTool.Builder

addBoostSpecs(int index, DataStoreTool.BoostSpecs.Builder builderForValue)

public DataStoreTool.Builder addBoostSpecs(int index, DataStoreTool.BoostSpecs.Builder builderForValue)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataStoreTool.BoostSpecs.Builder

Returns
Type	Description
DataStoreTool.Builder

addBoostSpecsBuilder()

public DataStoreTool.BoostSpecs.Builder addBoostSpecsBuilder()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.BoostSpecs.Builder

addBoostSpecsBuilder(int index)

public DataStoreTool.BoostSpecs.Builder addBoostSpecsBuilder(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.BoostSpecs.Builder

addModalityConfigs(DataStoreTool.ModalityConfig value)

public DataStoreTool.Builder addModalityConfigs(DataStoreTool.ModalityConfig value)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.ModalityConfig

Returns
Type	Description
DataStoreTool.Builder

addModalityConfigs(DataStoreTool.ModalityConfig.Builder builderForValue)

public DataStoreTool.Builder addModalityConfigs(DataStoreTool.ModalityConfig.Builder builderForValue)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DataStoreTool.ModalityConfig.Builder

Returns
Type	Description
DataStoreTool.Builder

addModalityConfigs(int index, DataStoreTool.ModalityConfig value)

public DataStoreTool.Builder addModalityConfigs(int index, DataStoreTool.ModalityConfig value)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataStoreTool.ModalityConfig

Returns
Type	Description
DataStoreTool.Builder

addModalityConfigs(int index, DataStoreTool.ModalityConfig.Builder builderForValue)

public DataStoreTool.Builder addModalityConfigs(int index, DataStoreTool.ModalityConfig.Builder builderForValue)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataStoreTool.ModalityConfig.Builder

Returns
Type	Description
DataStoreTool.Builder

addModalityConfigsBuilder()

public DataStoreTool.ModalityConfig.Builder addModalityConfigsBuilder()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.ModalityConfig.Builder

addModalityConfigsBuilder(int index)

public DataStoreTool.ModalityConfig.Builder addModalityConfigsBuilder(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.ModalityConfig.Builder

build()

public DataStoreTool build()

Returns
Type	Description
DataStoreTool

buildPartial()

public DataStoreTool buildPartial()

Returns
Type	Description
DataStoreTool

clear()

public DataStoreTool.Builder clear()

Returns
Type	Description
DataStoreTool.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearBoostSpecs()

public DataStoreTool.Builder clearBoostSpecs()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder

clearDataStoreSource()

public DataStoreTool.Builder clearDataStoreSource()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder

clearDescription()

public DataStoreTool.Builder clearDescription()

Optional. The tool description.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

clearEngineSource()

public DataStoreTool.Builder clearEngineSource()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder

clearFilterParameterBehavior()

public DataStoreTool.Builder clearFilterParameterBehavior()

Optional. The filter parameter behavior.

.google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

clearModalityConfigs()

public DataStoreTool.Builder clearModalityConfigs()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.Builder

clearName()

public DataStoreTool.Builder clearName()

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

clearSearchSource()

public DataStoreTool.Builder clearSearchSource()

Returns
Type	Description
DataStoreTool.Builder

getBoostSpecs(int index)

public DataStoreTool.BoostSpecs getBoostSpecs(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.BoostSpecs

getBoostSpecsBuilder(int index)

public DataStoreTool.BoostSpecs.Builder getBoostSpecsBuilder(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.BoostSpecs.Builder

getBoostSpecsBuilderList()

public List<DataStoreTool.BoostSpecs.Builder> getBoostSpecsBuilderList()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getBoostSpecsCount()

public int getBoostSpecsCount()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getBoostSpecsList()

public List<DataStoreTool.BoostSpecs> getBoostSpecsList()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<BoostSpecs>

getBoostSpecsOrBuilder(int index)

public DataStoreTool.BoostSpecsOrBuilder getBoostSpecsOrBuilder(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.BoostSpecsOrBuilder

getBoostSpecsOrBuilderList()

public List<? extends DataStoreTool.BoostSpecsOrBuilder> getBoostSpecsOrBuilderList()

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.ces.v1.DataStoreTool.BoostSpecsOrBuilder>

getDataStoreSource()

public DataStoreTool.DataStoreSource getDataStoreSource()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.DataStoreSource	The dataStoreSource.

getDataStoreSourceBuilder()

public DataStoreTool.DataStoreSource.Builder getDataStoreSourceBuilder()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.DataStoreSource.Builder

getDataStoreSourceOrBuilder()

public DataStoreTool.DataStoreSourceOrBuilder getDataStoreSourceOrBuilder()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.DataStoreSourceOrBuilder

getDefaultInstanceForType()

public DataStoreTool getDefaultInstanceForType()

Returns
Type	Description
DataStoreTool

getDescription()

public String getDescription()

Optional. The tool description.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The tool description.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEngineSource()

public DataStoreTool.EngineSource getEngineSource()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.EngineSource	The engineSource.

getEngineSourceBuilder()

public DataStoreTool.EngineSource.Builder getEngineSourceBuilder()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.EngineSource.Builder

getEngineSourceOrBuilder()

public DataStoreTool.EngineSourceOrBuilder getEngineSourceOrBuilder()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.EngineSourceOrBuilder

getFilterParameterBehavior()

public DataStoreTool.FilterParameterBehavior getFilterParameterBehavior()

Optional. The filter parameter behavior.

.google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DataStoreTool.FilterParameterBehavior	The filterParameterBehavior.

getFilterParameterBehaviorValue()

public int getFilterParameterBehaviorValue()

Optional. The filter parameter behavior.

.google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for filterParameterBehavior.

getModalityConfigs(int index)

public DataStoreTool.ModalityConfig getModalityConfigs(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.ModalityConfig

getModalityConfigsBuilder(int index)

public DataStoreTool.ModalityConfig.Builder getModalityConfigsBuilder(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.ModalityConfig.Builder

getModalityConfigsBuilderList()

public List<DataStoreTool.ModalityConfig.Builder> getModalityConfigsBuilderList()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getModalityConfigsCount()

public int getModalityConfigsCount()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getModalityConfigsList()

public List<DataStoreTool.ModalityConfig> getModalityConfigsList()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<ModalityConfig>

getModalityConfigsOrBuilder(int index)

public DataStoreTool.ModalityConfigOrBuilder getModalityConfigsOrBuilder(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.ModalityConfigOrBuilder

getModalityConfigsOrBuilderList()

public List<? extends DataStoreTool.ModalityConfigOrBuilder> getModalityConfigsOrBuilderList()

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.ces.v1.DataStoreTool.ModalityConfigOrBuilder>

getName()

public String getName()

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for name.

getSearchSourceCase()

public DataStoreTool.SearchSourceCase getSearchSourceCase()

Returns
Type	Description
DataStoreTool.SearchSourceCase

hasDataStoreSource()

public boolean hasDataStoreSource()

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the dataStoreSource field is set.

hasEngineSource()

public boolean hasEngineSource()

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the engineSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeDataStoreSource(DataStoreTool.DataStoreSource value)

public DataStoreTool.Builder mergeDataStoreSource(DataStoreTool.DataStoreSource value)

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.DataStoreSource

Returns
Type	Description
DataStoreTool.Builder

mergeEngineSource(DataStoreTool.EngineSource value)

public DataStoreTool.Builder mergeEngineSource(DataStoreTool.EngineSource value)

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.EngineSource

Returns
Type	Description
DataStoreTool.Builder

mergeFrom(DataStoreTool other)

public DataStoreTool.Builder mergeFrom(DataStoreTool other)

Parameter
Name	Description
other	DataStoreTool

Returns
Type	Description
DataStoreTool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataStoreTool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public DataStoreTool.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
DataStoreTool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

removeBoostSpecs(int index)

public DataStoreTool.Builder removeBoostSpecs(int index)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.Builder

removeModalityConfigs(int index)

public DataStoreTool.Builder removeModalityConfigs(int index)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
DataStoreTool.Builder

setBoostSpecs(int index, DataStoreTool.BoostSpecs value)

public DataStoreTool.Builder setBoostSpecs(int index, DataStoreTool.BoostSpecs value)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataStoreTool.BoostSpecs

Returns
Type	Description
DataStoreTool.Builder

setBoostSpecs(int index, DataStoreTool.BoostSpecs.Builder builderForValue)

public DataStoreTool.Builder setBoostSpecs(int index, DataStoreTool.BoostSpecs.Builder builderForValue)

Optional. Boost specification to boost certain documents.

repeated .google.cloud.ces.v1.DataStoreTool.BoostSpecs boost_specs = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataStoreTool.BoostSpecs.Builder

Returns
Type	Description
DataStoreTool.Builder

setDataStoreSource(DataStoreTool.DataStoreSource value)

public DataStoreTool.Builder setDataStoreSource(DataStoreTool.DataStoreSource value)

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.DataStoreSource

Returns
Type	Description
DataStoreTool.Builder

setDataStoreSource(DataStoreTool.DataStoreSource.Builder builderForValue)

public DataStoreTool.Builder setDataStoreSource(DataStoreTool.DataStoreSource.Builder builderForValue)

Optional. Search within a single specific DataStore.

.google.cloud.ces.v1.DataStoreTool.DataStoreSource data_store_source = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DataStoreTool.DataStoreSource.Builder

Returns
Type	Description
DataStoreTool.Builder

setDescription(String value)

public DataStoreTool.Builder setDescription(String value)

Optional. The tool description.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public DataStoreTool.Builder setDescriptionBytes(ByteString value)

Optional. The tool description.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

setEngineSource(DataStoreTool.EngineSource value)

public DataStoreTool.Builder setEngineSource(DataStoreTool.EngineSource value)

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.EngineSource

Returns
Type	Description
DataStoreTool.Builder

setEngineSource(DataStoreTool.EngineSource.Builder builderForValue)

public DataStoreTool.Builder setEngineSource(DataStoreTool.EngineSource.Builder builderForValue)

Optional. Search within an Engine (potentially across multiple DataStores).

.google.cloud.ces.v1.DataStoreTool.EngineSource engine_source = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	DataStoreTool.EngineSource.Builder

Returns
Type	Description
DataStoreTool.Builder

setFilterParameterBehavior(DataStoreTool.FilterParameterBehavior value)

public DataStoreTool.Builder setFilterParameterBehavior(DataStoreTool.FilterParameterBehavior value)

Optional. The filter parameter behavior.

.google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	DataStoreTool.FilterParameterBehavior The filterParameterBehavior to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

setFilterParameterBehaviorValue(int value)

public DataStoreTool.Builder setFilterParameterBehaviorValue(int value)

Optional. The filter parameter behavior.

.google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior filter_parameter_behavior = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for filterParameterBehavior to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

setModalityConfigs(int index, DataStoreTool.ModalityConfig value)

public DataStoreTool.Builder setModalityConfigs(int index, DataStoreTool.ModalityConfig value)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	DataStoreTool.ModalityConfig

Returns
Type	Description
DataStoreTool.Builder

setModalityConfigs(int index, DataStoreTool.ModalityConfig.Builder builderForValue)

public DataStoreTool.Builder setModalityConfigs(int index, DataStoreTool.ModalityConfig.Builder builderForValue)

Optional. The modality configs for the data store.

repeated .google.cloud.ces.v1.DataStoreTool.ModalityConfig modality_configs = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	DataStoreTool.ModalityConfig.Builder

Returns
Type	Description
DataStoreTool.Builder

setName(String value)

public DataStoreTool.Builder setName(String value)

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.

setNameBytes(ByteString value)

public DataStoreTool.Builder setNameBytes(ByteString value)

Required. The data store tool name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
DataStoreTool.Builder	This builder for chaining.