Class FileSearchTool.Builder (0.1.0)

public static final class FileSearchTool.Builder extends GeneratedMessage.Builder<FileSearchTool.Builder> implements FileSearchToolOrBuilder

The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.

Protobuf type google.cloud.ces.v1.FileSearchTool

Inheritance

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

Implements

FileSearchToolOrBuilder

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

build()

public FileSearchTool build()

Returns
Type	Description
FileSearchTool

buildPartial()

public FileSearchTool buildPartial()

Returns
Type	Description
FileSearchTool

clear()

public FileSearchTool.Builder clear()

Returns
Type	Description
FileSearchTool.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCorpusType()

public FileSearchTool.Builder clearCorpusType()

Optional. The type of the corpus. Default is FULLY_MANAGED.

.google.cloud.ces.v1.FileSearchTool.CorpusType corpus_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

clearDescription()

public FileSearchTool.Builder clearDescription()

Optional. The tool description.

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

clearFileCorpus()

public FileSearchTool.Builder clearFileCorpus()

Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

string file_corpus = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

clearName()

public FileSearchTool.Builder clearName()

Required. The tool name.

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

getCorpusType()

public FileSearchTool.CorpusType getCorpusType()

Optional. The type of the corpus. Default is FULLY_MANAGED.

.google.cloud.ces.v1.FileSearchTool.CorpusType corpus_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
FileSearchTool.CorpusType	The corpusType.

getCorpusTypeValue()

public int getCorpusTypeValue()

Optional. The type of the corpus. Default is FULLY_MANAGED.

.google.cloud.ces.v1.FileSearchTool.CorpusType corpus_type = 3 [(.google.api.field_behavior) = OPTIONAL];

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

getDefaultInstanceForType()

public FileSearchTool getDefaultInstanceForType()

Returns
Type	Description
FileSearchTool

getDescription()

public String getDescription()

Optional. The tool description.

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

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. The tool description.

string description = 5 [(.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()

getFileCorpus()

public String getFileCorpus()

Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

string file_corpus = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The fileCorpus.

getFileCorpusBytes()

public ByteString getFileCorpusBytes()

Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

string file_corpus = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for fileCorpus.

getName()

public String getName()

Required. The tool name.

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

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. The tool name.

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

Returns
Type	Description
ByteString	The bytes for name.

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()

mergeFrom(FileSearchTool other)

public FileSearchTool.Builder mergeFrom(FileSearchTool other)

Parameter
Name	Description
other	FileSearchTool

Returns
Type	Description
FileSearchTool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FileSearchTool.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FileSearchTool.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FileSearchTool.Builder

Overrides

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

setCorpusType(FileSearchTool.CorpusType value)

public FileSearchTool.Builder setCorpusType(FileSearchTool.CorpusType value)

Optional. The type of the corpus. Default is FULLY_MANAGED.

.google.cloud.ces.v1.FileSearchTool.CorpusType corpus_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	FileSearchTool.CorpusType The corpusType to set.

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setCorpusTypeValue(int value)

public FileSearchTool.Builder setCorpusTypeValue(int value)

Optional. The type of the corpus. Default is FULLY_MANAGED.

.google.cloud.ces.v1.FileSearchTool.CorpusType corpus_type = 3 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setDescription(String value)

public FileSearchTool.Builder setDescription(String value)

Optional. The tool description.

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public FileSearchTool.Builder setDescriptionBytes(ByteString value)

Optional. The tool description.

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

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setFileCorpus(String value)

public FileSearchTool.Builder setFileCorpus(String value)

Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

string file_corpus = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The fileCorpus to set.

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setFileCorpusBytes(ByteString value)

public FileSearchTool.Builder setFileCorpusBytes(ByteString value)

Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

string file_corpus = 6 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setName(String value)

public FileSearchTool.Builder setName(String value)

Required. The tool name.

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.

setNameBytes(ByteString value)

public FileSearchTool.Builder setNameBytes(ByteString value)

Required. The tool name.

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

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

Returns
Type	Description
FileSearchTool.Builder	This builder for chaining.