public final class Tool extends com.google.protobuf.GeneratedMessageV3 implements ToolOrBuilder
A tool provides a list of actions which are available to the [Playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to attain its goal. A Tool consists of a description of the tool's usage and a specification of the tool which contains the schema and authentication information.Protobuf type
google.cloud.dialogflow.cx.v3beta1.Tool| Modifier and Type | Class and Description |
|---|---|
static class |
Tool.Authentication
Authentication information required for API calls
Protobuf type
google.cloud.dialogflow.cx.v3beta1.Tool.Authentication |
static interface |
Tool.AuthenticationOrBuilder |
static class |
Tool.Builder
A tool provides a list of actions which are available to the
[Playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to attain its goal.
|
static class |
Tool.ConnectorTool
A ConnectorTool enabling using Integration Connectors Connections as tools.
|
static interface |
Tool.ConnectorToolOrBuilder |
static class |
Tool.DataStoreTool
A DataStoreTool is a way to provide specifications needed to search a
list of data stores.
|
static interface |
Tool.DataStoreToolOrBuilder |
static class |
Tool.EndUserAuthConfig
End-user authentication configuration used for Connection calls.
|
static interface |
Tool.EndUserAuthConfigOrBuilder |
static class |
Tool.ExtensionTool
An ExtensionTool is a way to use Vertex Extensions as a tool.
|
static interface |
Tool.ExtensionToolOrBuilder |
static class |
Tool.FunctionTool
A Function tool describes the functions to be invoked on the client side.
|
static interface |
Tool.FunctionToolOrBuilder |
static class |
Tool.OpenApiTool
An OpenAPI tool is a way to provide the Tool specifications in the Open API
schema format.
|
static interface |
Tool.OpenApiToolOrBuilder |
static class |
Tool.ServiceDirectoryConfig
Configuration for tools using Service Directory.
|
static interface |
Tool.ServiceDirectoryConfigOrBuilder |
static class |
Tool.SpecificationCase |
static class |
Tool.TLSConfig
The TLS configuration.
|
static interface |
Tool.TLSConfigOrBuilder |
static class |
Tool.ToolType
Represents the type of the tool.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CONNECTOR_SPEC_FIELD_NUMBER |
static int |
DATA_STORE_SPEC_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
EXTENSION_SPEC_FIELD_NUMBER |
static int |
FUNCTION_SPEC_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OPEN_API_SPEC_FIELD_NUMBER |
static int |
TOOL_TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Tool.ConnectorTool |
getConnectorSpec()
Integration connectors tool specification.
|
Tool.ConnectorToolOrBuilder |
getConnectorSpecOrBuilder()
Integration connectors tool specification.
|
Tool.DataStoreTool |
getDataStoreSpec()
Data store search tool specification.
|
Tool.DataStoreToolOrBuilder |
getDataStoreSpecOrBuilder()
Data store search tool specification.
|
static Tool |
getDefaultInstance() |
Tool |
getDefaultInstanceForType() |
String |
getDescription()
Required.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Required.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
Tool.ExtensionTool |
getExtensionSpec()
Vertex extension tool specification.
|
Tool.ExtensionToolOrBuilder |
getExtensionSpecOrBuilder()
Vertex extension tool specification.
|
Tool.FunctionTool |
getFunctionSpec()
Client side executed function specification.
|
Tool.FunctionToolOrBuilder |
getFunctionSpecOrBuilder()
Client side executed function specification.
|
String |
getName()
The unique identifier of the Tool.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique identifier of the Tool.
|
Tool.OpenApiTool |
getOpenApiSpec()
OpenAPI specification of the Tool.
|
Tool.OpenApiToolOrBuilder |
getOpenApiSpecOrBuilder()
OpenAPI specification of the Tool.
|
com.google.protobuf.Parser<Tool> |
getParserForType() |
int |
getSerializedSize() |
Tool.SpecificationCase |
getSpecificationCase() |
Tool.ToolType |
getToolType()
Output only.
|
int |
getToolTypeValue()
Output only.
|
boolean |
hasConnectorSpec()
Integration connectors tool specification.
|
boolean |
hasDataStoreSpec()
Data store search tool specification.
|
boolean |
hasExtensionSpec()
Vertex extension tool specification.
|
boolean |
hasFunctionSpec()
Client side executed function specification.
|
int |
hashCode() |
boolean |
hasOpenApiSpec()
OpenAPI specification of the Tool.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Tool.Builder |
newBuilder() |
static Tool.Builder |
newBuilder(Tool prototype) |
Tool.Builder |
newBuilderForType() |
protected Tool.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Tool |
parseDelimitedFrom(InputStream input) |
static Tool |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tool |
parseFrom(byte[] data) |
static Tool |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tool |
parseFrom(ByteBuffer data) |
static Tool |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tool |
parseFrom(com.google.protobuf.ByteString data) |
static Tool |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tool |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Tool |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tool |
parseFrom(InputStream input) |
static Tool |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Tool> |
parser() |
Tool.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int OPEN_API_SPEC_FIELD_NUMBER
public static final int DATA_STORE_SPEC_FIELD_NUMBER
public static final int EXTENSION_SPEC_FIELD_NUMBER
public static final int FUNCTION_SPEC_FIELD_NUMBER
public static final int CONNECTOR_SPEC_FIELD_NUMBER
public static final int TOOL_TYPE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Tool.SpecificationCase getSpecificationCase()
getSpecificationCase in interface ToolOrBuilderpublic String getName()
The unique identifier of the Tool. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
string name = 1;getName in interface ToolOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique identifier of the Tool. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
string name = 1;getNameBytes in interface ToolOrBuilderpublic String getDisplayName()
Required. The human-readable name of the Tool, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ToolOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The human-readable name of the Tool, unique within an agent.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ToolOrBuilderpublic String getDescription()
Required. High level description of the Tool and its usage.
string description = 3 [(.google.api.field_behavior) = REQUIRED];getDescription in interface ToolOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Required. High level description of the Tool and its usage.
string description = 3 [(.google.api.field_behavior) = REQUIRED];getDescriptionBytes in interface ToolOrBuilderpublic boolean hasOpenApiSpec()
OpenAPI specification of the Tool.
.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;hasOpenApiSpec in interface ToolOrBuilderpublic Tool.OpenApiTool getOpenApiSpec()
OpenAPI specification of the Tool.
.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;getOpenApiSpec in interface ToolOrBuilderpublic Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
OpenAPI specification of the Tool.
.google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;getOpenApiSpecOrBuilder in interface ToolOrBuilderpublic boolean hasDataStoreSpec()
Data store search tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;hasDataStoreSpec in interface ToolOrBuilderpublic Tool.DataStoreTool getDataStoreSpec()
Data store search tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;getDataStoreSpec in interface ToolOrBuilderpublic Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder()
Data store search tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;getDataStoreSpecOrBuilder in interface ToolOrBuilderpublic boolean hasExtensionSpec()
Vertex extension tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;hasExtensionSpec in interface ToolOrBuilderpublic Tool.ExtensionTool getExtensionSpec()
Vertex extension tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;getExtensionSpec in interface ToolOrBuilderpublic Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()
Vertex extension tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;getExtensionSpecOrBuilder in interface ToolOrBuilderpublic boolean hasFunctionSpec()
Client side executed function specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;hasFunctionSpec in interface ToolOrBuilderpublic Tool.FunctionTool getFunctionSpec()
Client side executed function specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;getFunctionSpec in interface ToolOrBuilderpublic Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()
Client side executed function specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;getFunctionSpecOrBuilder in interface ToolOrBuilderpublic boolean hasConnectorSpec()
Integration connectors tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;hasConnectorSpec in interface ToolOrBuilderpublic Tool.ConnectorTool getConnectorSpec()
Integration connectors tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;getConnectorSpec in interface ToolOrBuilderpublic Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()
Integration connectors tool specification.
.google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;getConnectorSpecOrBuilder in interface ToolOrBuilderpublic int getToolTypeValue()
Output only. The tool type.
.google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolTypeValue in interface ToolOrBuilderpublic Tool.ToolType getToolType()
Output only. The tool type.
.google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolType in interface ToolOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Tool parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tool parseFrom(InputStream input) throws IOException
IOExceptionpublic static Tool parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tool parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Tool parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tool parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Tool parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Tool.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Tool.Builder newBuilder()
public static Tool.Builder newBuilder(Tool prototype)
public Tool.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Tool.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Tool getDefaultInstance()
public static com.google.protobuf.Parser<Tool> parser()
public com.google.protobuf.Parser<Tool> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Tool getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.