public final class ToolUse extends GeneratedMessageV3 implements ToolUseOrBuilder
Stores metadata of the invocation of an action supported by a tool.
Protobuf type google.cloud.dialogflow.cx.v3beta1.ToolUse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INPUT_ACTION_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ToolUse getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ToolUse.Builder newBuilder()
public static ToolUse.Builder newBuilder(ToolUse prototype)
| Parameter |
| Name |
Description |
prototype |
ToolUse
|
public static ToolUse parseDelimitedFrom(InputStream input)
public static ToolUse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolUse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ToolUse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ToolUse parseFrom(ByteString data)
public static ToolUse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ToolUse parseFrom(CodedInputStream input)
public static ToolUse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolUse parseFrom(InputStream input)
public static ToolUse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ToolUse parseFrom(ByteBuffer data)
public static ToolUse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ToolUse> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
public ToolUse getDefaultInstanceForType()
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.
|
public StructOrBuilder getInputActionParametersOrBuilder()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
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.
|
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];
public Parser<ToolUse> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ToolUse.Builder newBuilderForType()
protected ToolUse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ToolUse.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
