Class ToolCallResult (0.56.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
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_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 ToolCallResult getDefaultInstance()
Returns
Type Description
ToolCallResult

getDescriptor()

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

newBuilder()

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

newBuilder(ToolCallResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 ToolCallResult getDefaultInstanceForType()
Returns
Type Description
ToolCallResult

getError()

public ToolCallResult.Error getError()

The tool call's error.

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

Returns
Type Description
ToolCallResult.Error

The error.

getErrorOrBuilder()

public ToolCallResult.ErrorOrBuilder getErrorOrBuilder()

The tool call's error.

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

Returns
Type Description
ToolCallResult.ErrorOrBuilder

getOutputParameters()

public Struct getOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
Struct

The outputParameters.

getOutputParametersOrBuilder()

public StructOrBuilder getOutputParametersOrBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
StructOrBuilder

getParserForType()

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

getResultCase()

public ToolCallResult.ResultCase getResultCase()
Returns
Type Description
ToolCallResult.ResultCase

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.

hasError()

public boolean hasError()

The tool call's error.

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

Returns
Type Description
boolean

Whether the error field is set.

hasOutputParameters()

public boolean hasOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
boolean

Whether the outputParameters 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 ToolCallResult.Builder newBuilderForType()
Returns
Type Description
ToolCallResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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