Class ToolUse.Builder (0.89.0) 

public static final class ToolUse.Builder extends GeneratedMessageV3.Builder<ToolUse.Builder> implements ToolUseOrBuilder

Stores metadata of the invocation of an action supported by a tool.

Protobuf type google.cloud.dialogflow.cx.v3beta1.ToolUse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ToolUse.Builder

Implements

ToolUseOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ToolUse build()
Returns
Type Description
ToolUse

buildPartial()

public ToolUse buildPartial()
Returns
Type Description
ToolUse

clear()

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

clearAction()

public ToolUse.Builder clearAction()

Optional. Name of the action to be called during the tool use.

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

Returns
Type Description
ToolUse.Builder

This builder for chaining.

clearDataStoreToolTrace()

public ToolUse.Builder clearDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.Builder

clearDisplayName()

public ToolUse.Builder clearDisplayName()

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ToolUse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInputActionParameters()

public ToolUse.Builder clearInputActionParameters()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOutputActionParameters()

public ToolUse.Builder clearOutputActionParameters()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.Builder

clearTool()

public ToolUse.Builder clearTool()

Required. The tool that should be used. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.

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

Returns
Type Description
ToolUse.Builder

This builder for chaining.

clearToolTrace()

public ToolUse.Builder clearToolTrace()
Returns
Type Description
ToolUse.Builder

clearWebhookToolTrace()

public ToolUse.Builder clearWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.Builder

clone()

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

getAction()

public String getAction()

Optional. Name of the action to be called during the tool use.

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

Returns
Type Description
String

The action.

getActionBytes()

public ByteString getActionBytes()

Optional. Name of the action to be called during the tool use.

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

Returns
Type Description
ByteString

The bytes for action.

getDataStoreToolTrace()

public ToolUse.DataStoreToolTrace getDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.DataStoreToolTrace

The dataStoreToolTrace.

getDataStoreToolTraceBuilder()

public ToolUse.DataStoreToolTrace.Builder getDataStoreToolTraceBuilder()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.DataStoreToolTrace.Builder

getDataStoreToolTraceOrBuilder()

public ToolUse.DataStoreToolTraceOrBuilder getDataStoreToolTraceOrBuilder()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.DataStoreToolTraceOrBuilder

getDefaultInstanceForType()

public ToolUse getDefaultInstanceForType()
Returns
Type Description
ToolUse

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getInputActionParameters()

public Struct getInputActionParameters()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The inputActionParameters.

getInputActionParametersBuilder()

public Struct.Builder getInputActionParametersBuilder()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getInputActionParametersOrBuilder()

public StructOrBuilder getInputActionParametersOrBuilder()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getOutputActionParameters()

public Struct getOutputActionParameters()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The outputActionParameters.

getOutputActionParametersBuilder()

public Struct.Builder getOutputActionParametersBuilder()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getOutputActionParametersOrBuilder()

public StructOrBuilder getOutputActionParametersOrBuilder()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getTool()

public String getTool()

Required. The tool that should be used. 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 that should be used. 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.

getToolTraceCase()

public ToolUse.ToolTraceCase getToolTraceCase()
Returns
Type Description
ToolUse.ToolTraceCase

getWebhookToolTrace()

public ToolUse.WebhookToolTrace getWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.WebhookToolTrace

The webhookToolTrace.

getWebhookToolTraceBuilder()

public ToolUse.WebhookToolTrace.Builder getWebhookToolTraceBuilder()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.WebhookToolTrace.Builder

getWebhookToolTraceOrBuilder()

public ToolUse.WebhookToolTraceOrBuilder getWebhookToolTraceOrBuilder()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolUse.WebhookToolTraceOrBuilder

hasDataStoreToolTrace()

public boolean hasDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the dataStoreToolTrace field is set.

hasInputActionParameters()

public boolean hasInputActionParameters()

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inputActionParameters field is set.

hasOutputActionParameters()

public boolean hasOutputActionParameters()

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the outputActionParameters field is set.

hasWebhookToolTrace()

public boolean hasWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the webhookToolTrace field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDataStoreToolTrace(ToolUse.DataStoreToolTrace value)

public ToolUse.Builder mergeDataStoreToolTrace(ToolUse.DataStoreToolTrace value)

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse.DataStoreToolTrace
Returns
Type Description
ToolUse.Builder

mergeFrom(ToolUse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeInputActionParameters(Struct value)

public ToolUse.Builder mergeInputActionParameters(Struct value)

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolUse.Builder

mergeOutputActionParameters(Struct value)

public ToolUse.Builder mergeOutputActionParameters(Struct value)

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolUse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeWebhookToolTrace(ToolUse.WebhookToolTrace value)

public ToolUse.Builder mergeWebhookToolTrace(ToolUse.WebhookToolTrace value)

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse.WebhookToolTrace
Returns
Type Description
ToolUse.Builder

setAction(String value)

public ToolUse.Builder setAction(String value)

Optional. Name of the action to be called during the tool use.

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

Parameter
Name Description
value String

The action to set.
Returns
Type Description
ToolUse.Builder

This builder for chaining.

setActionBytes(ByteString value)

public ToolUse.Builder setActionBytes(ByteString value)

Optional. Name of the action to be called during the tool use.

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

Parameter
Name Description
value ByteString

The bytes for action to set.
Returns
Type Description
ToolUse.Builder

This builder for chaining.

setDataStoreToolTrace(ToolUse.DataStoreToolTrace value)

public ToolUse.Builder setDataStoreToolTrace(ToolUse.DataStoreToolTrace value)

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse.DataStoreToolTrace
Returns
Type Description
ToolUse.Builder

setDataStoreToolTrace(ToolUse.DataStoreToolTrace.Builder builderForValue)

public ToolUse.Builder setDataStoreToolTrace(ToolUse.DataStoreToolTrace.Builder builderForValue)

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolUse.DataStoreToolTrace.Builder
Returns
Type Description
ToolUse.Builder

setDisplayName(String value)

public ToolUse.Builder setDisplayName(String value)

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
ToolUse.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ToolUse.Builder setDisplayNameBytes(ByteString value)

Output only. The display name of the tool.

string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
ToolUse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInputActionParameters(Struct value)

public ToolUse.Builder setInputActionParameters(Struct value)

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolUse.Builder

setInputActionParameters(Struct.Builder builderForValue)

public ToolUse.Builder setInputActionParameters(Struct.Builder builderForValue)

Optional. A list of input parameters for the action.

.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolUse.Builder

setOutputActionParameters(Struct value)

public ToolUse.Builder setOutputActionParameters(Struct value)

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
ToolUse.Builder

setOutputActionParameters(Struct.Builder builderForValue)

public ToolUse.Builder setOutputActionParameters(Struct.Builder builderForValue)

Optional. A list of output parameters generated by the action.

.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ToolUse.Builder

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

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

setTool(String value)

public ToolUse.Builder setTool(String value)

Required. The tool that should be used. 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
ToolUse.Builder

This builder for chaining.

setToolBytes(ByteString value)

public ToolUse.Builder setToolBytes(ByteString value)

Required. The tool that should be used. 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
ToolUse.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setWebhookToolTrace(ToolUse.WebhookToolTrace value)

public ToolUse.Builder setWebhookToolTrace(ToolUse.WebhookToolTrace value)

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolUse.WebhookToolTrace
Returns
Type Description
ToolUse.Builder

setWebhookToolTrace(ToolUse.WebhookToolTrace.Builder builderForValue)

public ToolUse.Builder setWebhookToolTrace(ToolUse.WebhookToolTrace.Builder builderForValue)

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolUse.WebhookToolTrace.Builder
Returns
Type Description
ToolUse.Builder