Class ToolCallResult (0.52.0)

public final class ToolCallResult extends GeneratedMessageV3 implements ToolCallResultOrBuilder

The result of calling a tool's action that has been executed by the client.

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

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ToolCallResult getDefaultInstance()
Returns
TypeDescription
ToolCallResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ToolCallResult.Builder newBuilder()
Returns
TypeDescription
ToolCallResult.Builder

newBuilder(ToolCallResult prototype)

public static ToolCallResult.Builder newBuilder(ToolCallResult prototype)
Parameter
NameDescription
prototypeToolCallResult
Returns
TypeDescription
ToolCallResult.Builder

parseDelimitedFrom(InputStream input)

public static ToolCallResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ToolCallResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ToolCallResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ToolCallResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ToolCallResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ToolCallResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ToolCallResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ToolCallResult> parser()
Returns
TypeDescription
Parser<ToolCallResult>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for action.

getDefaultInstanceForType()

public ToolCallResult getDefaultInstanceForType()
Returns
TypeDescription
ToolCallResult

getError()

public ToolCallResult.Error getError()

The tool call's error.

.google.cloud.dialogflow.cx.v3beta1.ToolCallResult.Error error = 3;

Returns
TypeDescription
ToolCallResult.Error

The error.

getErrorOrBuilder()

public ToolCallResult.ErrorOrBuilder getErrorOrBuilder()

The tool call's error.

.google.cloud.dialogflow.cx.v3beta1.ToolCallResult.Error error = 3;

Returns
TypeDescription
ToolCallResult.ErrorOrBuilder

getOutputParameters()

public Struct getOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
Struct

The outputParameters.

getOutputParametersOrBuilder()

public StructOrBuilder getOutputParametersOrBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
StructOrBuilder

getParserForType()

public Parser<ToolCallResult> getParserForType()
Returns
TypeDescription
Parser<ToolCallResult>
Overrides

getResultCase()

public ToolCallResult.ResultCase getResultCase()
Returns
TypeDescription
ToolCallResult.ResultCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for tool.

hasError()

public boolean hasError()

The tool call's error.

.google.cloud.dialogflow.cx.v3beta1.ToolCallResult.Error error = 3;

Returns
TypeDescription
boolean

Whether the error field is set.

hasOutputParameters()

public boolean hasOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
boolean

Whether the outputParameters field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ToolCallResult.Builder newBuilderForType()
Returns
TypeDescription
ToolCallResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ToolCallResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ToolCallResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ToolCallResult.Builder toBuilder()
Returns
TypeDescription
ToolCallResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException