Class ToolCallResult.Builder (0.52.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ToolCallResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ToolCallResult.Builder
Overrides

build()

public ToolCallResult build()
Returns
TypeDescription
ToolCallResult

buildPartial()

public ToolCallResult buildPartial()
Returns
TypeDescription
ToolCallResult

clear()

public ToolCallResult.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ToolCallResult.Builder

clearField(Descriptors.FieldDescriptor field)

public ToolCallResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ToolCallResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ToolCallResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ToolCallResult.Builder
Overrides

clearOutputParameters()

public ToolCallResult.Builder clearOutputParameters()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
ToolCallResult.Builder

clearResult()

public ToolCallResult.Builder clearResult()
Returns
TypeDescription
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
TypeDescription
ToolCallResult.Builder

This builder for chaining.

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getErrorBuilder()

public ToolCallResult.Error.Builder getErrorBuilder()

The tool call's error.

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

Returns
TypeDescription
ToolCallResult.Error.Builder

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.

getOutputParametersBuilder()

public Struct.Builder getOutputParametersBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
Builder

getOutputParametersOrBuilder()

public StructOrBuilder getOutputParametersOrBuilder()

The tool call's output parameters.

.google.protobuf.Struct output_parameters = 4;

Returns
TypeDescription
StructOrBuilder

getResultCase()

public ToolCallResult.ResultCase getResultCase()
Returns
TypeDescription
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
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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueToolCallResult.Error
Returns
TypeDescription
ToolCallResult.Builder

mergeFrom(ToolCallResult other)

public ToolCallResult.Builder mergeFrom(ToolCallResult other)
Parameter
NameDescription
otherToolCallResult
Returns
TypeDescription
ToolCallResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ToolCallResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolCallResult.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ToolCallResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
ToolCallResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ToolCallResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The action to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for action to set.

Returns
TypeDescription
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
NameDescription
valueToolCallResult.Error
Returns
TypeDescription
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
NameDescription
builderForValueToolCallResult.Error.Builder
Returns
TypeDescription
ToolCallResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ToolCallResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
ToolCallResult.Builder

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

public ToolCallResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The tool to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for tool to set.

Returns
TypeDescription
ToolCallResult.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ToolCallResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ToolCallResult.Builder
Overrides