Class ToolCall (0.66.0) 

public final class ToolCall extends GeneratedMessageV3 implements ToolCallOrBuilder

Represents a call of a specific tool's action with the specified inputs.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ToolCall

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ToolCall

Implements

ToolCallOrBuilder

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
Type Description
int

INPUT_PARAMETERS_FIELD_NUMBER

public static final int INPUT_PARAMETERS_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

getAction()

public String getAction()

The name of the tool's action associated with this call.

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

Returns
Type Description
String

The action.

getActionBytes()

public ByteString getActionBytes()

The name of the tool's action associated with this call.

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

Returns
Type Description
ByteString

The bytes for action.

getDefaultInstanceForType()

public ToolCall getDefaultInstanceForType()
Returns
Type Description
ToolCall

getInputParameters()

public Struct getInputParameters()

The action's input parameters.

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

Returns
Type Description
Struct

The inputParameters.

getInputParametersOrBuilder()

public StructOrBuilder getInputParametersOrBuilder()

The action's input parameters.

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

Returns
Type Description
StructOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTool()

public String getTool()

The tool associated with this call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

The tool associated with this call. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tool.

hasInputParameters()

public boolean hasInputParameters()

The action's input parameters.

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

Returns
Type Description
boolean

Whether the inputParameters field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
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