Class ToolCall.Builder (0.1.0) 

public static final class ToolCall.Builder extends GeneratedMessage.Builder<ToolCall.Builder> implements ToolCallOrBuilder

Request for the client or the agent to execute the specified tool.

Protobuf type google.cloud.ces.v1.ToolCall

Inheritance

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

Implements

ToolCallOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ToolCall build()
Returns
Type Description
ToolCall

buildPartial()

public ToolCall buildPartial()
Returns
Type Description
ToolCall

clear()

public ToolCall.Builder clear()
Returns
Type Description
ToolCall.Builder
Overrides

clearArgs()

public ToolCall.Builder clearArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

clearDisplayName()

public ToolCall.Builder clearDisplayName()

Output only. Display name of the tool.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearId()

public ToolCall.Builder clearId()

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearTool()

public ToolCall.Builder clearTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearToolIdentifier()

public ToolCall.Builder clearToolIdentifier()
Returns
Type Description
ToolCall.Builder

clearToolsetTool()

public ToolCall.Builder clearToolsetTool()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

getArgs()

public Struct getArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The args.

getArgsBuilder()

public Struct.Builder getArgsBuilder()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getArgsOrBuilder()

public StructOrBuilder getArgsOrBuilder()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public ToolCall getDefaultInstanceForType()
Returns
Type Description
ToolCall

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Output only. Display name of the tool.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. Display name of the tool.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getId()

public String getId()

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for id.

getTool()

public String getTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tool.

getToolIdentifierCase()

public ToolCall.ToolIdentifierCase getToolIdentifierCase()
Returns
Type Description
ToolCall.ToolIdentifierCase

getToolsetTool()

public ToolsetTool getToolsetTool()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetTool

The toolsetTool.

getToolsetToolBuilder()

public ToolsetTool.Builder getToolsetToolBuilder()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetTool.Builder

getToolsetToolOrBuilder()

public ToolsetToolOrBuilder getToolsetToolOrBuilder()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetToolOrBuilder

hasArgs()

public boolean hasArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the args field is set.

hasTool()

public boolean hasTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the tool field is set.

hasToolsetTool()

public boolean hasToolsetTool()

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolsetTool field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArgs(Struct value)

public ToolCall.Builder mergeArgs(Struct value)

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolCall.Builder

mergeFrom(ToolCall other)

public ToolCall.Builder mergeFrom(ToolCall other)
Parameter
Name Description
other ToolCall
Returns
Type Description
ToolCall.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ToolCall.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ToolCall.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ToolCall.Builder
Overrides

mergeToolsetTool(ToolsetTool value)

public ToolCall.Builder mergeToolsetTool(ToolsetTool value)

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolsetTool
Returns
Type Description
ToolCall.Builder

setArgs(Struct value)

public ToolCall.Builder setArgs(Struct value)

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolCall.Builder

setArgs(Struct.Builder builderForValue)

public ToolCall.Builder setArgs(Struct.Builder builderForValue)

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolCall.Builder

setDisplayName(String value)

public ToolCall.Builder setDisplayName(String value)

Output only. Display name of the tool.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ToolCall.Builder setDisplayNameBytes(ByteString value)

Output only. Display name of the tool.

string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setId(String value)

public ToolCall.Builder setId(String value)

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The id to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setIdBytes(ByteString value)

public ToolCall.Builder setIdBytes(ByteString value)

Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.

string id = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setTool(String value)

public ToolCall.Builder setTool(String value)

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The tool to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolBytes(ByteString value)

public ToolCall.Builder setToolBytes(ByteString value)

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for tool to set.
Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolsetTool(ToolsetTool value)

public ToolCall.Builder setToolsetTool(ToolsetTool value)

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolsetTool
Returns
Type Description
ToolCall.Builder

setToolsetTool(ToolsetTool.Builder builderForValue)

public ToolCall.Builder setToolsetTool(ToolsetTool.Builder builderForValue)

Optional. The toolset tool to execute.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolsetTool.Builder
Returns
Type Description
ToolCall.Builder