com.google.cloud.dialogflow.cx.v3beta1

Interface ToolUseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ToolUse, ToolUse.Builder

public interface ToolUseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAction() Optional.
com.google.protobuf.ByteString	getActionBytes() Optional.
String	getDisplayName() Output only.
com.google.protobuf.ByteString	getDisplayNameBytes() Output only.
com.google.protobuf.Struct	getInputActionParameters() Optional.
com.google.protobuf.StructOrBuilder	getInputActionParametersOrBuilder() Optional.
com.google.protobuf.Struct	getOutputActionParameters() Optional.
com.google.protobuf.StructOrBuilder	getOutputActionParametersOrBuilder() Optional.
String	getTool() Required.
com.google.protobuf.ByteString	getToolBytes() Required.
boolean	hasInputActionParameters() Optional.
boolean	hasOutputActionParameters() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTool

String getTool()

 Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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:

The tool.

getToolBytes

com.google.protobuf.ByteString getToolBytes()

 Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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:

The bytes for tool.

getDisplayName

String getDisplayName()

 Output only. The display name of the tool.
 

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

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Output only. The display name of the tool.
 

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

Returns:

The bytes for displayName.

getAction

String getAction()

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

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

Returns:

The action.

getActionBytes

com.google.protobuf.ByteString getActionBytes()

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

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

Returns:

The bytes for action.

hasInputActionParameters

boolean hasInputActionParameters()

 Optional. A list of input parameters for the action.
 

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

Returns:

Whether the inputActionParameters field is set.

getInputActionParameters

com.google.protobuf.Struct getInputActionParameters()

 Optional. A list of input parameters for the action.
 

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

Returns:

The inputActionParameters.

getInputActionParametersOrBuilder

com.google.protobuf.StructOrBuilder getInputActionParametersOrBuilder()

 Optional. A list of input parameters for the action.
 

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

hasOutputActionParameters

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:

Whether the outputActionParameters field is set.

getOutputActionParameters

com.google.protobuf.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:

The outputActionParameters.

getOutputActionParametersOrBuilder

com.google.protobuf.StructOrBuilder getOutputActionParametersOrBuilder()

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

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