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_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OUTPUT_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 ActionParameter getInputParameters(int index)
A list of input parameters for the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;
| Parameter |
| Name |
Description |
index |
int
|
public int getInputParametersCount()
A list of input parameters for the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;
| Returns |
| Type |
Description |
int |
|
public List<ActionParameter> getInputParametersList()
A list of input parameters for the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;
public ActionParameterOrBuilder getInputParametersOrBuilder(int index)
A list of input parameters for the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends ActionParameterOrBuilder> getInputParametersOrBuilderList()
A list of input parameters for the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder> |
|
public ActionParameter getOutputParameters(int index)
A list of output parameters generated by the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;
| Parameter |
| Name |
Description |
index |
int
|
public int getOutputParametersCount()
A list of output parameters generated by the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;
| Returns |
| Type |
Description |
int |
|
public List<ActionParameter> getOutputParametersList()
A list of output parameters generated by the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;
public ActionParameterOrBuilder getOutputParametersOrBuilder(int index)
A list of output parameters generated by the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends ActionParameterOrBuilder> getOutputParametersOrBuilderList()
A list of output parameters generated by the action.
repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ActionParameterOrBuilder> |
|
public Parser<ToolUse> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
Required. The tool that should
be used. Format: projects/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/tools/<Tool ID>.
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/<Project ID>/locations/<Location
ID>/agents/<Agent ID>/tools/<Tool ID>.
string tool = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for tool.
|
| 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
