Class ToolCall.Builder (0.94.0)

public static final class ToolCall.Builder extends GeneratedMessage.Builder<ToolCall.Builder> implements ToolCallOrBuilder

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

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

Implements

ToolCallOrBuilder

Static Methods

getDescriptor()

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

Methods

build()

public ToolCall build()
Returns
Type Description
ToolCall

buildPartial()

public ToolCall buildPartial()
Returns
Type Description
ToolCall

clear()

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

clearAction()

public ToolCall.Builder clearAction()

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

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

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearInputParameters()

public ToolCall.Builder clearInputParameters()

Optional. The action's input parameters.

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

Returns
Type Description
ToolCall.Builder

clearTool()

public ToolCall.Builder clearTool()

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

Returns
Type Description
ToolCall.Builder

This builder for chaining.

getAction()

public String getAction()

Required. 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()

Required. 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

getDescriptorForType()

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

getInputParameters()

public Struct getInputParameters()

Optional. The action's input parameters.

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

Returns
Type Description
Struct

The inputParameters.

getInputParametersBuilder()

public Struct.Builder getInputParametersBuilder()

Optional. The action's input parameters.

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

Returns
Type Description
Builder

getInputParametersOrBuilder()

public StructOrBuilder getInputParametersOrBuilder()

Optional. The action's input parameters.

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

Returns
Type Description
StructOrBuilder

getTool()

public String getTool()

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

Returns
Type Description
ByteString

The bytes for tool.

hasInputParameters()

public boolean hasInputParameters()

Optional. 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ToolCall other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInputParameters(Struct value)

public ToolCall.Builder mergeInputParameters(Struct value)

Optional. The action's input parameters.

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

Parameter
Name Description
value Struct
Returns
Type Description
ToolCall.Builder

setAction(String value)

public ToolCall.Builder setAction(String value)

Required. 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
ToolCall.Builder

This builder for chaining.

setActionBytes(ByteString value)

public ToolCall.Builder setActionBytes(ByteString value)

Required. 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
ToolCall.Builder

This builder for chaining.

setInputParameters(Struct value)

public ToolCall.Builder setInputParameters(Struct value)

Optional. The action's input parameters.

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

Parameter
Name Description
value Struct
Returns
Type Description
ToolCall.Builder

setInputParameters(Struct.Builder builderForValue)

public ToolCall.Builder setInputParameters(Struct.Builder builderForValue)

Optional. The action's input parameters.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolCall.Builder

setTool(String value)

public ToolCall.Builder setTool(String value)

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

Parameter
Name Description
value String

The tool to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolBytes(ByteString value)

public ToolCall.Builder setToolBytes(ByteString value)

Required. The tool associated with this call. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

This builder for chaining.