Class ToolUse (0.89.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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ToolUse

Implements

ToolUseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACTION_FIELD_NUMBER

public static final int ACTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DATA_STORE_TOOL_TRACE_FIELD_NUMBER

public static final int DATA_STORE_TOOL_TRACE_FIELD_NUMBER

Field Value
Type	Description
`int`

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

INPUT_ACTION_PARAMETERS_FIELD_NUMBER

public static final int INPUT_ACTION_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
`int`

OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER

public static final int OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER

Field Value
Type	Description
`int`

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER

Field Value
Type	Description
`int`

WEBHOOK_TOOL_TRACE_FIELD_NUMBER

public static final int WEBHOOK_TOOL_TRACE_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

AbstractMessage.equals(Object other)

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.

getDataStoreToolTrace()

public ToolUse.DataStoreToolTrace getDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolUse.DataStoreToolTrace`	The dataStoreToolTrace.

getDataStoreToolTraceOrBuilder()

public ToolUse.DataStoreToolTraceOrBuilder getDataStoreToolTraceOrBuilder()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolUse.DataStoreToolTraceOrBuilder`

getDefaultInstanceForType()

public ToolUse getDefaultInstanceForType()

Returns
Type	Description
`ToolUse`

getDisplayName()

public String getDisplayName()

Output only. The display name of the tool.

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

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of the tool.

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

Returns
Type	Description
`ByteString`	The bytes for displayName.

getInputActionParameters()

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.

getInputActionParametersOrBuilder()

public StructOrBuilder getInputActionParametersOrBuilder()

Optional. A list of input parameters for the action.

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

Returns
Type	Description
`StructOrBuilder`

getOutputActionParameters()

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.

getOutputActionParametersOrBuilder()

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];

Returns
Type	Description
`StructOrBuilder`

getParserForType()

public Parser<ToolUse> getParserForType()

Returns
Type	Description
`Parser<ToolUse>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTool()

public String getTool()

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.

getToolBytes()

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.

getToolTraceCase()

public ToolUse.ToolTraceCase getToolTraceCase()

Returns
Type	Description
`ToolUse.ToolTraceCase`

getWebhookToolTrace()

public ToolUse.WebhookToolTrace getWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolUse.WebhookToolTrace`	The webhookToolTrace.

getWebhookToolTraceOrBuilder()

public ToolUse.WebhookToolTraceOrBuilder getWebhookToolTraceOrBuilder()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ToolUse.WebhookToolTraceOrBuilder`

hasDataStoreToolTrace()

public boolean hasDataStoreToolTrace()

Optional. Data store tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the dataStoreToolTrace field is set.

hasInputActionParameters()

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.

hasOutputActionParameters()

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.

hasWebhookToolTrace()

public boolean hasWebhookToolTrace()

Optional. Webhook tool trace.

.google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the webhookToolTrace field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ToolUse.Builder toBuilder()

Returns
Type	Description
`ToolUse.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`