public static final class ToolUse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder> implements ToolUseOrBuilder
Stores metadata of the invocation of an action supported by a tool.Protobuf type
google.cloud.dialogflow.cx.v3beta1.ToolUse| Modifier and Type | Method and Description |
|---|---|
ToolUse.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ToolUse |
build() |
ToolUse |
buildPartial() |
ToolUse.Builder |
clear() |
ToolUse.Builder |
clearAction()
Optional.
|
ToolUse.Builder |
clearDisplayName()
Output only.
|
ToolUse.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ToolUse.Builder |
clearInputActionParameters()
Optional.
|
ToolUse.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ToolUse.Builder |
clearOutputActionParameters()
Optional.
|
ToolUse.Builder |
clearTool()
Required.
|
ToolUse.Builder |
clone() |
String |
getAction()
Optional.
|
com.google.protobuf.ByteString |
getActionBytes()
Optional.
|
ToolUse |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
Output only.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Output only.
|
com.google.protobuf.Struct |
getInputActionParameters()
Optional.
|
com.google.protobuf.Struct.Builder |
getInputActionParametersBuilder()
Optional.
|
com.google.protobuf.StructOrBuilder |
getInputActionParametersOrBuilder()
Optional.
|
com.google.protobuf.Struct |
getOutputActionParameters()
Optional.
|
com.google.protobuf.Struct.Builder |
getOutputActionParametersBuilder()
Optional.
|
com.google.protobuf.StructOrBuilder |
getOutputActionParametersOrBuilder()
Optional.
|
String |
getTool()
Required.
|
com.google.protobuf.ByteString |
getToolBytes()
Required.
|
boolean |
hasInputActionParameters()
Optional.
|
boolean |
hasOutputActionParameters()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ToolUse.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ToolUse.Builder |
mergeFrom(com.google.protobuf.Message other) |
ToolUse.Builder |
mergeFrom(ToolUse other) |
ToolUse.Builder |
mergeInputActionParameters(com.google.protobuf.Struct value)
Optional.
|
ToolUse.Builder |
mergeOutputActionParameters(com.google.protobuf.Struct value)
Optional.
|
ToolUse.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ToolUse.Builder |
setAction(String value)
Optional.
|
ToolUse.Builder |
setActionBytes(com.google.protobuf.ByteString value)
Optional.
|
ToolUse.Builder |
setDisplayName(String value)
Output only.
|
ToolUse.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Output only.
|
ToolUse.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ToolUse.Builder |
setInputActionParameters(com.google.protobuf.Struct.Builder builderForValue)
Optional.
|
ToolUse.Builder |
setInputActionParameters(com.google.protobuf.Struct value)
Optional.
|
ToolUse.Builder |
setOutputActionParameters(com.google.protobuf.Struct.Builder builderForValue)
Optional.
|
ToolUse.Builder |
setOutputActionParameters(com.google.protobuf.Struct value)
Optional.
|
ToolUse.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ToolUse.Builder |
setTool(String value)
Required.
|
ToolUse.Builder |
setToolBytes(com.google.protobuf.ByteString value)
Required.
|
ToolUse.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ToolUse build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ToolUse buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ToolUse.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ToolUse.Builder>public ToolUse.Builder mergeFrom(ToolUse other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public ToolUse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ToolUse.Builder>IOExceptionpublic String getTool()
Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
getTool in interface ToolUseOrBuilderpublic com.google.protobuf.ByteString getToolBytes()
Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
getToolBytes in interface ToolUseOrBuilderpublic ToolUse.Builder setTool(String value)
Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
value - The tool to set.public ToolUse.Builder clearTool()
Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
public ToolUse.Builder setToolBytes(com.google.protobuf.ByteString value)
Required. The [tool][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
value - The bytes for tool to set.public String getDisplayName()
Output only. The display name of the tool.
string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];getDisplayName in interface ToolUseOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Output only. The display name of the tool.
string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];getDisplayNameBytes in interface ToolUseOrBuilderpublic ToolUse.Builder setDisplayName(String value)
Output only. The display name of the tool.
string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The displayName to set.public ToolUse.Builder clearDisplayName()
Output only. The display name of the tool.
string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];public ToolUse.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Output only. The display name of the tool.
string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for displayName to set.public String getAction()
Optional. Name of the action to be called during the tool use.
string action = 2 [(.google.api.field_behavior) = OPTIONAL];getAction in interface ToolUseOrBuilderpublic com.google.protobuf.ByteString getActionBytes()
Optional. Name of the action to be called during the tool use.
string action = 2 [(.google.api.field_behavior) = OPTIONAL];getActionBytes in interface ToolUseOrBuilderpublic ToolUse.Builder setAction(String value)
Optional. Name of the action to be called during the tool use.
string action = 2 [(.google.api.field_behavior) = OPTIONAL];value - The action to set.public ToolUse.Builder clearAction()
Optional. Name of the action to be called during the tool use.
string action = 2 [(.google.api.field_behavior) = OPTIONAL];public ToolUse.Builder setActionBytes(com.google.protobuf.ByteString value)
Optional. Name of the action to be called during the tool use.
string action = 2 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for action to set.public boolean hasInputActionParameters()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
hasInputActionParameters in interface ToolUseOrBuilderpublic com.google.protobuf.Struct getInputActionParameters()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
getInputActionParameters in interface ToolUseOrBuilderpublic ToolUse.Builder setInputActionParameters(com.google.protobuf.Struct value)
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder setInputActionParameters(com.google.protobuf.Struct.Builder builderForValue)
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder mergeInputActionParameters(com.google.protobuf.Struct value)
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder clearInputActionParameters()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
public com.google.protobuf.Struct.Builder getInputActionParametersBuilder()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
public com.google.protobuf.StructOrBuilder getInputActionParametersOrBuilder()
Optional. A list of input parameters for the action.
.google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
getInputActionParametersOrBuilder in interface ToolUseOrBuilderpublic boolean hasOutputActionParameters()
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
hasOutputActionParameters in interface ToolUseOrBuilderpublic com.google.protobuf.Struct getOutputActionParameters()
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
getOutputActionParameters in interface ToolUseOrBuilderpublic ToolUse.Builder setOutputActionParameters(com.google.protobuf.Struct value)
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder setOutputActionParameters(com.google.protobuf.Struct.Builder builderForValue)
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder mergeOutputActionParameters(com.google.protobuf.Struct value)
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
public ToolUse.Builder clearOutputActionParameters()
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
public com.google.protobuf.Struct.Builder getOutputActionParametersBuilder()
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
public com.google.protobuf.StructOrBuilder getOutputActionParametersOrBuilder()
Optional. A list of output parameters generated by the action.
.google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
getOutputActionParametersOrBuilder in interface ToolUseOrBuilderpublic final ToolUse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>public final ToolUse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ToolUse.Builder>Copyright © 2025 Google LLC. All rights reserved.