Class ToolCall (0.1.0)

public final class ToolCall extends GeneratedMessage implements ToolCallOrBuilder

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

Protobuf type google.cloud.ces.v1.ToolCall

Implements

ToolCallOrBuilder

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

TOOLSET_TOOL_FIELD_NUMBER

public static final int TOOLSET_TOOL_FIELD_NUMBER
Field Value
Type Description
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ToolCall getDefaultInstance()
Returns
Type Description
ToolCall

getDescriptor()

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

newBuilder()

public static ToolCall.Builder newBuilder()
Returns
Type Description
ToolCall.Builder

newBuilder(ToolCall prototype)

public static ToolCall.Builder newBuilder(ToolCall prototype)
Parameter
Name Description
prototype ToolCall
Returns
Type Description
ToolCall.Builder

parseDelimitedFrom(InputStream input)

public static ToolCall parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ToolCall parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ToolCall parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ToolCall parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ToolCall parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ToolCall parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ToolCall parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolCall
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ToolCall> parser()
Returns
Type Description
Parser<ToolCall>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

getParserForType()

public Parser<ToolCall> getParserForType()
Returns
Type Description
Parser<ToolCall>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ToolCall.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ToolCall.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException