Class ToolUseExample.Builder (3.42.0)

Version latest

• 3.42.0 (latest)
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class ToolUseExample.Builder extends GeneratedMessageV3.Builder<ToolUseExample.Builder> implements ToolUseExampleOrBuilder

A single example of the tool usage.

Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ToolUseExample.Builder

Implements

ToolUseExampleOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ToolUseExample.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ToolUseExample build()

Returns
Type	Description
ToolUseExample

buildPartial()

public ToolUseExample buildPartial()

Returns
Type	Description
ToolUseExample

clear()

public ToolUseExample.Builder clear()

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDisplayName()

public ToolUseExample.Builder clearDisplayName()

Required. The display name for example.

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

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

clearExtensionOperation()

public ToolUseExample.Builder clearExtensionOperation()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
Type	Description
ToolUseExample.Builder

clearField(Descriptors.FieldDescriptor field)

public ToolUseExample.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFunctionName()

public ToolUseExample.Builder clearFunctionName()

Function name to call.

string function_name = 11;

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ToolUseExample.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuery()

public ToolUseExample.Builder clearQuery()

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

clearRequestParams()

public ToolUseExample.Builder clearRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type	Description
ToolUseExample.Builder

clearResponseParams()

public ToolUseExample.Builder clearResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type	Description
ToolUseExample.Builder

clearResponseSummary()

public ToolUseExample.Builder clearResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

clearTarget()

public ToolUseExample.Builder clearTarget()

Returns
Type	Description
ToolUseExample.Builder

clone()

public ToolUseExample.Builder clone()

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ToolUseExample getDefaultInstanceForType()

Returns
Type	Description
ToolUseExample

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Required. The display name for example.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name for example.

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

Returns
Type	Description
ByteString	The bytes for displayName.

getExtensionOperation()

public ToolUseExample.ExtensionOperation getExtensionOperation()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
Type	Description
ToolUseExample.ExtensionOperation	The extensionOperation.

getExtensionOperationBuilder()

public ToolUseExample.ExtensionOperation.Builder getExtensionOperationBuilder()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
Type	Description
ToolUseExample.ExtensionOperation.Builder

getExtensionOperationOrBuilder()

public ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
Type	Description
ToolUseExample.ExtensionOperationOrBuilder

getFunctionName()

public String getFunctionName()

Function name to call.

string function_name = 11;

Returns
Type	Description
String	The functionName.

getFunctionNameBytes()

public ByteString getFunctionNameBytes()

Function name to call.

string function_name = 11;

Returns
Type	Description
ByteString	The bytes for functionName.

getQuery()

public String getQuery()

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for query.

getRequestParams()

public Struct getRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type	Description
Struct	The requestParams.

getRequestParamsBuilder()

public Struct.Builder getRequestParamsBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type	Description
Builder

getRequestParamsOrBuilder()

public StructOrBuilder getRequestParamsOrBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type	Description
StructOrBuilder

getResponseParams()

public Struct getResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type	Description
Struct	The responseParams.

getResponseParamsBuilder()

public Struct.Builder getResponseParamsBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type	Description
Builder

getResponseParamsOrBuilder()

public StructOrBuilder getResponseParamsOrBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type	Description
StructOrBuilder

getResponseSummary()

public String getResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
Type	Description
String	The responseSummary.

getResponseSummaryBytes()

public ByteString getResponseSummaryBytes()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
Type	Description
ByteString	The bytes for responseSummary.

getTargetCase()

public ToolUseExample.TargetCase getTargetCase()

Returns
Type	Description
ToolUseExample.TargetCase

hasExtensionOperation()

public boolean hasExtensionOperation()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
Type	Description
boolean	Whether the extensionOperation field is set.

hasFunctionName()

public boolean hasFunctionName()

Function name to call.

string function_name = 11;

Returns
Type	Description
boolean	Whether the functionName field is set.

hasRequestParams()

public boolean hasRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type	Description
boolean	Whether the requestParams field is set.

hasResponseParams()

public boolean hasResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type	Description
boolean	Whether the responseParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeExtensionOperation(ToolUseExample.ExtensionOperation value)

public ToolUseExample.Builder mergeExtensionOperation(ToolUseExample.ExtensionOperation value)

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Parameter
Name	Description
value	ToolUseExample.ExtensionOperation

Returns
Type	Description
ToolUseExample.Builder

mergeFrom(ToolUseExample other)

public ToolUseExample.Builder mergeFrom(ToolUseExample other)

Parameter
Name	Description
other	ToolUseExample

Returns
Type	Description
ToolUseExample.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ToolUseExample.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ToolUseExample.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ToolUseExample.Builder

Overrides

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

mergeRequestParams(Struct value)

public ToolUseExample.Builder mergeRequestParams(Struct value)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
Name	Description
value	Struct

Returns
Type	Description
ToolUseExample.Builder

mergeResponseParams(Struct value)

public ToolUseExample.Builder mergeResponseParams(Struct value)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
Name	Description
value	Struct

Returns
Type	Description
ToolUseExample.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ToolUseExample.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDisplayName(String value)

public ToolUseExample.Builder setDisplayName(String value)

Required. The display name for example.

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

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public ToolUseExample.Builder setDisplayNameBytes(ByteString value)

Required. The display name for example.

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

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

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setExtensionOperation(ToolUseExample.ExtensionOperation value)

public ToolUseExample.Builder setExtensionOperation(ToolUseExample.ExtensionOperation value)

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Parameter
Name	Description
value	ToolUseExample.ExtensionOperation

Returns
Type	Description
ToolUseExample.Builder

setExtensionOperation(ToolUseExample.ExtensionOperation.Builder builderForValue)

public ToolUseExample.Builder setExtensionOperation(ToolUseExample.ExtensionOperation.Builder builderForValue)

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Parameter
Name	Description
builderForValue	ToolUseExample.ExtensionOperation.Builder

Returns
Type	Description
ToolUseExample.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ToolUseExample.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFunctionName(String value)

public ToolUseExample.Builder setFunctionName(String value)

Function name to call.

string function_name = 11;

Parameter
Name	Description
value	String The functionName to set.

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setFunctionNameBytes(ByteString value)

public ToolUseExample.Builder setFunctionNameBytes(ByteString value)

Function name to call.

string function_name = 11;

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

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setQuery(String value)

public ToolUseExample.Builder setQuery(String value)

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The query to set.

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public ToolUseExample.Builder setQueryBytes(ByteString value)

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ToolUseExample.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequestParams(Struct value)

public ToolUseExample.Builder setRequestParams(Struct value)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
Name	Description
value	Struct

Returns
Type	Description
ToolUseExample.Builder

setRequestParams(Struct.Builder builderForValue)

public ToolUseExample.Builder setRequestParams(Struct.Builder builderForValue)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
ToolUseExample.Builder

setResponseParams(Struct value)

public ToolUseExample.Builder setResponseParams(Struct value)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
Name	Description
value	Struct

Returns
Type	Description
ToolUseExample.Builder

setResponseParams(Struct.Builder builderForValue)

public ToolUseExample.Builder setResponseParams(Struct.Builder builderForValue)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
ToolUseExample.Builder

setResponseSummary(String value)

public ToolUseExample.Builder setResponseSummary(String value)

Summary of the tool response to the user query.

string response_summary = 5;

Parameter
Name	Description
value	String The responseSummary to set.

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setResponseSummaryBytes(ByteString value)

public ToolUseExample.Builder setResponseSummaryBytes(ByteString value)

Summary of the tool response to the user query.

string response_summary = 5;

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

Returns
Type	Description
ToolUseExample.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ToolUseExample.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ToolUseExample.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)