Package com.google.cloud.dialogflow.cx.v3

Interface ToolOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tool, Tool.Builder
@Generated public interface ToolOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

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

    • getDisplayName

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

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getDescription

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

    • getDescriptionBytes

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

    • hasOpenApiSpec

      boolean hasOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;
      Returns:
      Whether the openApiSpec field is set.

    • getOpenApiSpec

      Tool.OpenApiTool getOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;
      Returns:
      The openApiSpec.

    • getOpenApiSpecOrBuilder

      Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • hasDataStoreSpec

      boolean hasDataStoreSpec()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;
      Returns:
      Whether the dataStoreSpec field is set.

    • getDataStoreSpec

      Tool.DataStoreTool getDataStoreSpec()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;
      Returns:
      The dataStoreSpec.

    • getDataStoreSpecOrBuilder

      Tool.DataStoreToolOrBuilder getDataStoreSpecOrBuilder()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • hasFunctionSpec

      boolean hasFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;
      Returns:
      Whether the functionSpec field is set.

    • getFunctionSpec

      Tool.FunctionTool getFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;
      Returns:
      The functionSpec.

    • getFunctionSpecOrBuilder

      Tool.FunctionToolOrBuilder getFunctionSpecOrBuilder()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • getToolTypeValue

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

    • getToolType

      Tool.ToolType getToolType()
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The toolType.

    • getSpecificationCase

      Tool.SpecificationCase getSpecificationCase()