Class ToolCall.Builder (4.87.0)

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

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

Protobuf type google.cloud.dialogflow.v2beta1.ToolCall

Implements

ToolCallOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

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

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

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearAnswerRecord()

public ToolCall.Builder clearAnswerRecord()

Optional. The answer record associated with this tool call.

string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearCreateTime()

public ToolCall.Builder clearCreateTime()

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ToolCall.Builder

clearField(Descriptors.FieldDescriptor field)

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSource()

public ToolCall.Builder clearSource()
Returns
Type Description
ToolCall.Builder

clearState()

public ToolCall.Builder clearState()

Output only. State of the tool call

.google.cloud.dialogflow.v2beta1.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearTool()

public ToolCall.Builder clearTool()

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

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

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearToolDisplayDetails()

public ToolCall.Builder clearToolDisplayDetails()

Optional. A human readable description of the tool.

string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clearToolDisplayName()

public ToolCall.Builder clearToolDisplayName()

Optional. A human readable short name of the tool, to be shown on the UI.

string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolCall.Builder

This builder for chaining.

clone()

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

getAction()

public String getAction()

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

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

Returns
Type Description
String

The action.

getActionBytes()

public ByteString getActionBytes()

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

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

Returns
Type Description
ByteString

The bytes for action.

getAnswerRecord()

public String getAnswerRecord()

Optional. The answer record associated with this tool call.

string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The answerRecord.

getAnswerRecordBytes()

public ByteString getAnswerRecordBytes()

Optional. The answer record associated with this tool call.

string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for answerRecord.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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

getSourceCase()

public ToolCall.SourceCase getSourceCase()
Returns
Type Description
ToolCall.SourceCase

getState()

public ToolCall.State getState()

Output only. State of the tool call

.google.cloud.dialogflow.v2beta1.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ToolCall.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the tool call

.google.cloud.dialogflow.v2beta1.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTool()

public String getTool()

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

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

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

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

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

Returns
Type Description
ByteString

The bytes for tool.

getToolDisplayDetails()

public String getToolDisplayDetails()

Optional. A human readable description of the tool.

string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The toolDisplayDetails.

getToolDisplayDetailsBytes()

public ByteString getToolDisplayDetailsBytes()

Optional. A human readable description of the tool.

string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for toolDisplayDetails.

getToolDisplayName()

public String getToolDisplayName()

Optional. A human readable short name of the tool, to be shown on the UI.

string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The toolDisplayName.

getToolDisplayNameBytes()

public ByteString getToolDisplayNameBytes()

Optional. A human readable short name of the tool, to be shown on the UI.

string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for toolDisplayName.

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

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.

hasTool()

public boolean hasTool()

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

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

Returns
Type Description
boolean

Whether the tool field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ToolCall.Builder mergeCreateTime(Timestamp value)

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ToolCall.Builder

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAction(String value)

public ToolCall.Builder setAction(String value)

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

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

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)

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

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

Parameter
Name Description
value ByteString

The bytes for action to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setAnswerRecord(String value)

public ToolCall.Builder setAnswerRecord(String value)

Optional. The answer record associated with this tool call.

string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The answerRecord to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setAnswerRecordBytes(ByteString value)

public ToolCall.Builder setAnswerRecordBytes(ByteString value)

Optional. The answer record associated with this tool call.

string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for answerRecord to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public ToolCall.Builder setCreateTime(Timestamp value)

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ToolCall.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ToolCall.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Create time of the tool call.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolCall.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

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

setState(ToolCall.State value)

public ToolCall.Builder setState(ToolCall.State value)

Output only. State of the tool call

.google.cloud.dialogflow.v2beta1.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ToolCall.State

The state to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setStateValue(int value)

public ToolCall.Builder setStateValue(int value)

Output only. State of the tool call

.google.cloud.dialogflow.v2beta1.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setTool(String value)

public ToolCall.Builder setTool(String value)

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

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.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)

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

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

Parameter
Name Description
value ByteString

The bytes for tool to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolDisplayDetails(String value)

public ToolCall.Builder setToolDisplayDetails(String value)

Optional. A human readable description of the tool.

string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The toolDisplayDetails to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolDisplayDetailsBytes(ByteString value)

public ToolCall.Builder setToolDisplayDetailsBytes(ByteString value)

Optional. A human readable description of the tool.

string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for toolDisplayDetails to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolDisplayName(String value)

public ToolCall.Builder setToolDisplayName(String value)

Optional. A human readable short name of the tool, to be shown on the UI.

string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The toolDisplayName to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setToolDisplayNameBytes(ByteString value)

public ToolCall.Builder setToolDisplayNameBytes(ByteString value)

Optional. A human readable short name of the tool, to be shown on the UI.

string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for toolDisplayName to set.

Returns
Type Description
ToolCall.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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