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

Class Tool.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>
com.google.cloud.dialogflow.cx.v3.Tool.Builder
All Implemented Interfaces:
ToolOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Tool
public static final class Tool.Builder extends com.google.protobuf.GeneratedMessage.Builder<Tool.Builder> implements ToolOrBuilder
 A tool provides a list of actions which are available to the
 [Playbook][google.cloud.dialogflow.cx.v3.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.v3.Tool

  • 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.Builder<Tool.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Tool.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Tool.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Builder>

    • mergeFrom

      public Tool.Builder mergeFrom(Tool other)

    • isInitialized

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

    • mergeFrom

      public Tool.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.Builder>
      Throws:
      IOException

    • getSpecificationCase

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

    • clearSpecification

      public Tool.Builder clearSpecification()

    • 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.

    • setName

      public Tool.Builder setName(String value)
       The unique identifier of the Tool.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Tool.Builder clearName()
       The unique identifier of the Tool.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Tool.Builder setNameBytes(com.google.protobuf.ByteString value)
       The unique identifier of the Tool.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDisplayName

      public Tool.Builder setDisplayName(String value)
       Required. The human-readable name of the Tool, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public Tool.Builder clearDisplayName()
       Required. The human-readable name of the Tool, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public Tool.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Required. The human-readable name of the Tool, unique within an agent.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • 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.

    • setDescription

      public Tool.Builder setDescription(String value)
       Required. High level description of the Tool and its usage.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Tool.Builder clearDescription()
       Required. High level description of the Tool and its usage.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Tool.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       Required. High level description of the Tool and its usage.
      string description = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • hasOpenApiSpec

      public boolean hasOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.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.v3.Tool.OpenApiTool open_api_spec = 4;
      Specified by:
      getOpenApiSpec in interface ToolOrBuilder
      Returns:
      The openApiSpec.

    • setOpenApiSpec

      public Tool.Builder setOpenApiSpec(Tool.OpenApiTool value)
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • setOpenApiSpec

      public Tool.Builder setOpenApiSpec(Tool.OpenApiTool.Builder builderForValue)
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • mergeOpenApiSpec

      public Tool.Builder mergeOpenApiSpec(Tool.OpenApiTool value)
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • clearOpenApiSpec

      public Tool.Builder clearOpenApiSpec()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • getOpenApiSpecBuilder

      public Tool.OpenApiTool.Builder getOpenApiSpecBuilder()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.Tool.OpenApiTool open_api_spec = 4;

    • getOpenApiSpecOrBuilder

      public Tool.OpenApiToolOrBuilder getOpenApiSpecOrBuilder()
       OpenAPI specification of the Tool.
      .google.cloud.dialogflow.cx.v3.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.v3.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.v3.Tool.DataStoreTool data_store_spec = 8;
      Specified by:
      getDataStoreSpec in interface ToolOrBuilder
      Returns:
      The dataStoreSpec.

    • setDataStoreSpec

      public Tool.Builder setDataStoreSpec(Tool.DataStoreTool value)
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • setDataStoreSpec

      public Tool.Builder setDataStoreSpec(Tool.DataStoreTool.Builder builderForValue)
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • mergeDataStoreSpec

      public Tool.Builder mergeDataStoreSpec(Tool.DataStoreTool value)
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • clearDataStoreSpec

      public Tool.Builder clearDataStoreSpec()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • getDataStoreSpecBuilder

      public Tool.DataStoreTool.Builder getDataStoreSpecBuilder()
       Data store search tool specification.
      .google.cloud.dialogflow.cx.v3.Tool.DataStoreTool data_store_spec = 8;

    • getDataStoreSpecOrBuilder

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

    • hasFunctionSpec

      public boolean hasFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.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.v3.Tool.FunctionTool function_spec = 13;
      Specified by:
      getFunctionSpec in interface ToolOrBuilder
      Returns:
      The functionSpec.

    • setFunctionSpec

      public Tool.Builder setFunctionSpec(Tool.FunctionTool value)
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • setFunctionSpec

      public Tool.Builder setFunctionSpec(Tool.FunctionTool.Builder builderForValue)
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • mergeFunctionSpec

      public Tool.Builder mergeFunctionSpec(Tool.FunctionTool value)
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • clearFunctionSpec

      public Tool.Builder clearFunctionSpec()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • getFunctionSpecBuilder

      public Tool.FunctionTool.Builder getFunctionSpecBuilder()
       Client side executed function specification.
      .google.cloud.dialogflow.cx.v3.Tool.FunctionTool function_spec = 13;

    • getFunctionSpecOrBuilder

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

    • getToolTypeValue

      public int getToolTypeValue()
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3.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.

    • setToolTypeValue

      public Tool.Builder setToolTypeValue(int value)
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The enum numeric value on the wire for toolType to set.
      Returns:
      This builder for chaining.

    • getToolType

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

    • setToolType

      public Tool.Builder setToolType(Tool.ToolType value)
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The toolType to set.
      Returns:
      This builder for chaining.

    • clearToolType

      public Tool.Builder clearToolType()
       Output only. The tool type.
      .google.cloud.dialogflow.cx.v3.Tool.ToolType tool_type = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.