Package com.google.cloud.dialogflow.cx.v3beta1

Class Tool

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Tool
All Implemented Interfaces:
ToolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Tool extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • OPEN_API_SPEC_FIELD_NUMBER

      public static final int OPEN_API_SPEC_FIELD_NUMBER
      See Also:

    • DATA_STORE_SPEC_FIELD_NUMBER

      public static final int DATA_STORE_SPEC_FIELD_NUMBER
      See Also:

    • EXTENSION_SPEC_FIELD_NUMBER

      public static final int EXTENSION_SPEC_FIELD_NUMBER
      See Also:

    • FUNCTION_SPEC_FIELD_NUMBER

      public static final int FUNCTION_SPEC_FIELD_NUMBER
      See Also:

    • CONNECTOR_SPEC_FIELD_NUMBER

      public static final int CONNECTOR_SPEC_FIELD_NUMBER
      See Also:

    • TOOL_TYPE_FIELD_NUMBER

      public static final int TOOL_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSpecificationCase

      public Tool.SpecificationCase getSpecificationCase()
      Specified by:
      getSpecificationCase in interface ToolOrBuilder

    • getName

      public String getName()
       The unique identifier of the Tool.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
      string name = 1;
      Specified by:
      getName in interface ToolOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The unique identifier of the Tool.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
      string name = 1;
      Specified by:
      getNameBytes in interface ToolOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The human-readable name of the Tool, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface ToolOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface ToolOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Required. High level description of the Tool and its usage.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescription in interface ToolOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Required. High level description of the Tool and its usage.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescriptionBytes in interface ToolOrBuilder
      Returns:
      The bytes for description.

    • hasOpenApiSpec

      public boolean hasOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
      Specified by:
      hasOpenApiSpec in interface ToolOrBuilder
      Returns:
      Whether the openApiSpec field is set.

    • getOpenApiSpec

      public Tool.OpenApiTool getOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
      Specified by:
      getOpenApiSpec in interface ToolOrBuilder
      Returns:
      The openApiSpec.

    • getOpenApiSpecOrBuilder

      public Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3beta1.Tool.OpenApiTool open_api_spec = 4;
      Specified by:
      getOpenApiSpecOrBuilder in interface ToolOrBuilder

    • hasDataStoreSpec

      public boolean hasDataStoreSpec()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
      Specified by:
      hasDataStoreSpec in interface ToolOrBuilder
      Returns:
      Whether the dataStoreSpec field is set.

    • getDataStoreSpec

      public Tool.DataStoreTool getDataStoreSpec()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
      Specified by:
      getDataStoreSpec in interface ToolOrBuilder
      Returns:
      The dataStoreSpec.

    • getDataStoreSpecOrBuilder

      public Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.DataStoreTool data_store_spec = 8;
      Specified by:
      getDataStoreSpecOrBuilder in interface ToolOrBuilder

    • hasExtensionSpec

      public boolean hasExtensionSpec()
       Vertex extension tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
      Specified by:
      hasExtensionSpec in interface ToolOrBuilder
      Returns:
      Whether the extensionSpec field is set.

    • getExtensionSpec

      public Tool.ExtensionTool getExtensionSpec()
       Vertex extension tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
      Specified by:
      getExtensionSpec in interface ToolOrBuilder
      Returns:
      The extensionSpec.

    • getExtensionSpecOrBuilder

      public Tool.ExtensionToolOrBuilder getExtensionSpecOrBuilder()
       Vertex extension tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ExtensionTool extension_spec = 11;
      Specified by:
      getExtensionSpecOrBuilder in interface ToolOrBuilder

    • hasFunctionSpec

      public boolean hasFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
      Specified by:
      hasFunctionSpec in interface ToolOrBuilder
      Returns:
      Whether the functionSpec field is set.

    • getFunctionSpec

      public Tool.FunctionTool getFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
      Specified by:
      getFunctionSpec in interface ToolOrBuilder
      Returns:
      The functionSpec.

    • getFunctionSpecOrBuilder

      public Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.FunctionTool function_spec = 13;
      Specified by:
      getFunctionSpecOrBuilder in interface ToolOrBuilder

    • hasConnectorSpec

      public boolean hasConnectorSpec()
       Integration connectors tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;
      Specified by:
      hasConnectorSpec in interface ToolOrBuilder
      Returns:
      Whether the connectorSpec field is set.

    • getConnectorSpec

      public Tool.ConnectorTool getConnectorSpec()
       Integration connectors tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;
      Specified by:
      getConnectorSpec in interface ToolOrBuilder
      Returns:
      The connectorSpec.

    • getConnectorSpecOrBuilder

      public Tool.ConnectorToolOrBuilder getConnectorSpecOrBuilder()
       Integration connectors tool specification.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ConnectorTool connector_spec = 15;
      Specified by:
      getConnectorSpecOrBuilder in interface ToolOrBuilder

    • getToolTypeValue

      public int getToolTypeValue()
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getToolTypeValue in interface ToolOrBuilder
      Returns:
      The enum numeric value on the wire for toolType.

    • getToolType

      public Tool.ToolType getToolType()
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3beta1.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getToolType in interface ToolOrBuilder
      Returns:
      The toolType.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Tool parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Tool.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Tool.Builder newBuilder()

    • newBuilder

      public static Tool.Builder newBuilder(Tool prototype)

    • toBuilder

      public Tool.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Tool.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Tool getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Tool> parser()

    • getParserForType

      public com.google.protobuf.Parser<Tool> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Tool getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder