Class ToolUse (0.46.0)
0.98.0 (latest)
0.96.0
0.94.0
0.93.0
0.92.0
0.91.0
0.89.0
0.87.0
0.86.0
0.85.0
0.84.0
0.83.0
0.81.0
0.79.0
0.78.0
0.75.0
0.74.0
0.73.0
0.71.0
0.70.0
0.69.0
0.68.0
0.67.0
0.66.0
0.65.0
0.64.0
0.63.0
0.62.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.43.0
0.42.0
0.41.0
0.40.0
0.39.0
0.38.0
0.35.0
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.7
0.13.1
0.12.1
0.11.5
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
prototypeToolUse
public static ToolUse parseDelimitedFrom ( InputStream input )
public static ToolUse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static ToolUse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
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
objObject
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
indexint
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
indexint
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
indexint
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
indexint
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
