Class DataStoreTool (0.1.0)

public final class DataStoreTool extends GeneratedMessage 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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > DataStoreTool

Implements

DataStoreToolOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_SPECS_FIELD_NUMBER

public static final int BOOST_SPECS_FIELD_NUMBER

Field Value
Type	Description
int

DATA_STORE_SOURCE_FIELD_NUMBER

public static final int DATA_STORE_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

ENGINE_SOURCE_FIELD_NUMBER

public static final int ENGINE_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

FILTER_PARAMETER_BEHAVIOR_FIELD_NUMBER

public static final int FILTER_PARAMETER_BEHAVIOR_FIELD_NUMBER

Field Value
Type	Description
int

MODALITY_CONFIGS_FIELD_NUMBER

public static final int MODALITY_CONFIGS_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DataStoreTool getDefaultInstance()

Returns
Type	Description
DataStoreTool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DataStoreTool.Builder newBuilder()

Returns
Type	Description
DataStoreTool.Builder

newBuilder(DataStoreTool prototype)

public static DataStoreTool.Builder newBuilder(DataStoreTool prototype)

Parameter
Name	Description
prototype	DataStoreTool

Returns
Type	Description
DataStoreTool.Builder

parseDelimitedFrom(InputStream input)

public static DataStoreTool parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DataStoreTool parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStoreTool parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStoreTool parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DataStoreTool parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DataStoreTool parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStoreTool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DataStoreTool

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DataStoreTool> parser()

Returns
Type	Description
Parser<DataStoreTool>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.

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.

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.

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

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.

getParserForType()

public Parser<DataStoreTool> getParserForType()

Returns
Type	Description
Parser<DataStoreTool>

Overrides

GeneratedMessage.getParserForType()

getSearchSourceCase()

public DataStoreTool.SearchSourceCase getSearchSourceCase()

Returns
Type	Description
DataStoreTool.SearchSourceCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public DataStoreTool.Builder newBuilderForType()

Returns
Type	Description
DataStoreTool.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DataStoreTool.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DataStoreTool.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public DataStoreTool.Builder toBuilder()

Returns
Type	Description
DataStoreTool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException