Class ToolCallResult.Builder (0.57.0)

public static final class ToolCallResult.Builder extends GeneratedMessageV3.Builder<ToolCallResult.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ToolCallResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ToolCallResult.Builder
Overrides

build()

public ToolCallResult build()
Returns
Type Description
ToolCallResult

buildPartial()

public ToolCallResult buildPartial()
Returns
Type Description
ToolCallResult

clear()

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

clearAction()

public ToolCallResult.Builder clearAction()

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

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

Returns
Type Description
ToolCallResult.Builder

This builder for chaining.

clearError()

public ToolCallResult.Builder clearError()

The tool call's error.

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

Returns
Type Description
ToolCallResult.Builder

clearField(Descriptors.FieldDescriptor field)

public ToolCallResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ToolCallResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ToolCallResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ToolCallResult.Builder
Overrides

clearOutputParameters()

public ToolCallResult.Builder clearOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
ToolCallResult.Builder

clearResult()

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

clearTool()

public ToolCallResult.Builder clearTool()

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
ToolCallResult.Builder

This builder for chaining.

clone()

public ToolCallResult.Builder clone()
Returns
Type Description
ToolCallResult.Builder
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

getDescriptorForType()

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

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.

getErrorBuilder()

public ToolCallResult.Error.Builder getErrorBuilder()

The tool call's error.

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

Returns
Type Description
ToolCallResult.Error.Builder

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.

getOutputParametersBuilder()

public Struct.Builder getOutputParametersBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
Builder

getOutputParametersOrBuilder()

public StructOrBuilder getOutputParametersOrBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
Type Description
StructOrBuilder

getResultCase()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeError(ToolCallResult.Error value)

public ToolCallResult.Builder mergeError(ToolCallResult.Error value)

The tool call's error.

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

Parameter
Name Description
value ToolCallResult.Error
Returns
Type Description
ToolCallResult.Builder

mergeFrom(ToolCallResult other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeOutputParameters(Struct value)

public ToolCallResult.Builder mergeOutputParameters(Struct value)

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Parameter
Name Description
value Struct
Returns
Type Description
ToolCallResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ToolCallResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ToolCallResult.Builder
Overrides

setAction(String value)

public ToolCallResult.Builder setAction(String value)

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

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

Parameter
Name Description
value String

The action to set.

Returns
Type Description
ToolCallResult.Builder

This builder for chaining.

setActionBytes(ByteString value)

public ToolCallResult.Builder setActionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for action to set.

Returns
Type Description
ToolCallResult.Builder

This builder for chaining.

setError(ToolCallResult.Error value)

public ToolCallResult.Builder setError(ToolCallResult.Error value)

The tool call's error.

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

Parameter
Name Description
value ToolCallResult.Error
Returns
Type Description
ToolCallResult.Builder

setError(ToolCallResult.Error.Builder builderForValue)

public ToolCallResult.Builder setError(ToolCallResult.Error.Builder builderForValue)

The tool call's error.

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

Parameter
Name Description
builderForValue ToolCallResult.Error.Builder
Returns
Type Description
ToolCallResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ToolCallResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ToolCallResult.Builder
Overrides

setOutputParameters(Struct value)

public ToolCallResult.Builder setOutputParameters(Struct value)

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Parameter
Name Description
value Struct
Returns
Type Description
ToolCallResult.Builder

setOutputParameters(Struct.Builder builderForValue)

public ToolCallResult.Builder setOutputParameters(Struct.Builder builderForValue)

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolCallResult.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ToolCallResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ToolCallResult.Builder
Overrides

setTool(String value)

public ToolCallResult.Builder setTool(String value)

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) = { ... }

Parameter
Name Description
value String

The tool to set.

Returns
Type Description
ToolCallResult.Builder

This builder for chaining.

setToolBytes(ByteString value)

public ToolCallResult.Builder setToolBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for tool to set.

Returns
Type Description
ToolCallResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ToolCallResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ToolCallResult.Builder
Overrides