Class ToolUse (0.55.0)

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

Implements

ToolUseOrBuilder

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER
Field Value
Type Description
int

INPUT_PARAMETERS_FIELD_NUMBER

public static final int INPUT_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ToolUse getDefaultInstance()
Returns
Type Description
ToolUse

getDescriptor()

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

newBuilder()

public static ToolUse.Builder newBuilder()
Returns
Type Description
ToolUse.Builder

newBuilder(ToolUse prototype)

public static ToolUse.Builder newBuilder(ToolUse prototype)
Parameter
Name Description
prototype ToolUse
Returns
Type Description
ToolUse.Builder

parseDelimitedFrom(InputStream input)

public static ToolUse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ToolUse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ToolUse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ToolUse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ToolUse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ToolUse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ToolUse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ToolUse> parser()
Returns
Type Description
Parser<ToolUse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

getDefaultInstanceForType()

public ToolUse getDefaultInstanceForType()
Returns
Type Description
ToolUse

getInputParameters(int index)

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
Returns
Type Description
ActionParameter

getInputParametersCount()

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

getInputParametersList()

public List<ActionParameter> getInputParametersList()

A list of input parameters for the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter input_parameters = 3;

Returns
Type Description
List<ActionParameter>

getInputParametersOrBuilder(int index)

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
Returns
Type Description
ActionParameterOrBuilder

getInputParametersOrBuilderList()

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>

getOutputParameters(int index)

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
Returns
Type Description
ActionParameter

getOutputParametersCount()

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

getOutputParametersList()

public List<ActionParameter> getOutputParametersList()

A list of output parameters generated by the action.

repeated .google.cloud.dialogflow.cx.v3beta1.ActionParameter output_parameters = 4;

Returns
Type Description
List<ActionParameter>

getOutputParametersOrBuilder(int index)

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
Returns
Type Description
ActionParameterOrBuilder

getOutputParametersOrBuilderList()

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>

getParserForType()

public Parser<ToolUse> getParserForType()
Returns
Type Description
Parser<ToolUse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTool()

public String getTool()

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.

getToolBytes()

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ToolUse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ToolUse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException