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

Class ToolUse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ToolUse.Builder>
com.google.cloud.dialogflow.cx.v3beta1.ToolUse.Builder
All Implemented Interfaces:
ToolUseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ToolUse
public static final class ToolUse.Builder extends com.google.protobuf.GeneratedMessage.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

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

    • clear

      public ToolUse.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<ToolUse.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<ToolUse.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ToolUse.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<ToolUse.Builder>

    • mergeFrom

      public ToolUse.Builder mergeFrom(ToolUse other)

    • isInitialized

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

    • mergeFrom

      public ToolUse.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<ToolUse.Builder>
      Throws:
      IOException

    • getToolTraceCase

      public ToolUse.ToolTraceCase getToolTraceCase()
      Specified by:
      getToolTraceCase in interface ToolUseOrBuilder

    • clearToolTrace

      public ToolUse.Builder clearToolTrace()

    • getTool

      public 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) = { ... }
      Specified by:
      getTool in interface ToolUseOrBuilder
      Returns:
      The tool.

    • getToolBytes

      public 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) = { ... }
      Specified by:
      getToolBytes in interface ToolUseOrBuilder
      Returns:
      The bytes for tool.

    • setTool

      public 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) = { ... }
      Parameters:
      value - The tool to set.
      Returns:
      This builder for chaining.

    • clearTool

      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) = { ... }
      Returns:
      This builder for chaining.

    • setToolBytes

      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) = { ... }
      Parameters:
      value - The bytes for tool to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       Output only. The display name of the tool.
      string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayName in interface ToolUseOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Output only. The display name of the tool.
      string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayNameBytes in interface ToolUseOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public ToolUse.Builder setDisplayName(String value)
       Output only. The display name of the tool.
      string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public ToolUse.Builder clearDisplayName()
       Output only. The display name of the tool.
      string display_name = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getAction

      public String getAction()
       Optional. Name of the action to be called during the tool use.
      string action = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAction in interface ToolUseOrBuilder
      Returns:
      The action.

    • getActionBytes

      public 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];
      Specified by:
      getActionBytes in interface ToolUseOrBuilder
      Returns:
      The bytes for action.

    • setAction

      public 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];
      Parameters:
      value - The action to set.
      Returns:
      This builder for chaining.

    • clearAction

      public ToolUse.Builder clearAction()
       Optional. Name of the action to be called during the tool use.
      string action = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setActionBytes

      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];
      Parameters:
      value - The bytes for action to set.
      Returns:
      This builder for chaining.

    • hasInputActionParameters

      public boolean hasInputActionParameters()
       Optional. A list of input parameters for the action.
      .google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInputActionParameters in interface ToolUseOrBuilder
      Returns:
      Whether the inputActionParameters field is set.

    • getInputActionParameters

      public 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];
      Specified by:
      getInputActionParameters in interface ToolUseOrBuilder
      Returns:
      The inputActionParameters.

    • setInputActionParameters

      public 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];

    • setInputActionParameters

      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];

    • mergeInputActionParameters

      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];

    • clearInputActionParameters

      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];

    • getInputActionParametersBuilder

      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];

    • getInputActionParametersOrBuilder

      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];
      Specified by:
      getInputActionParametersOrBuilder in interface ToolUseOrBuilder

    • hasOutputActionParameters

      public boolean hasOutputActionParameters()
       Optional. A list of output parameters generated by the action.
      .google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasOutputActionParameters in interface ToolUseOrBuilder
      Returns:
      Whether the outputActionParameters field is set.

    • getOutputActionParameters

      public 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];
      Specified by:
      getOutputActionParameters in interface ToolUseOrBuilder
      Returns:
      The outputActionParameters.

    • setOutputActionParameters

      public 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];

    • setOutputActionParameters

      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];

    • mergeOutputActionParameters

      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];

    • clearOutputActionParameters

      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];

    • getOutputActionParametersBuilder

      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];

    • getOutputActionParametersOrBuilder

      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];
      Specified by:
      getOutputActionParametersOrBuilder in interface ToolUseOrBuilder

    • hasDataStoreToolTrace

      public boolean hasDataStoreToolTrace()
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasDataStoreToolTrace in interface ToolUseOrBuilder
      Returns:
      Whether the dataStoreToolTrace field is set.

    • getDataStoreToolTrace

      public ToolUse.DataStoreToolTrace getDataStoreToolTrace()
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreToolTrace in interface ToolUseOrBuilder
      Returns:
      The dataStoreToolTrace.

    • setDataStoreToolTrace

      public ToolUse.Builder setDataStoreToolTrace(ToolUse.DataStoreToolTrace value)
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setDataStoreToolTrace

      public ToolUse.Builder setDataStoreToolTrace(ToolUse.DataStoreToolTrace.Builder builderForValue)
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeDataStoreToolTrace

      public ToolUse.Builder mergeDataStoreToolTrace(ToolUse.DataStoreToolTrace value)
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearDataStoreToolTrace

      public ToolUse.Builder clearDataStoreToolTrace()
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getDataStoreToolTraceBuilder

      public ToolUse.DataStoreToolTrace.Builder getDataStoreToolTraceBuilder()
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getDataStoreToolTraceOrBuilder

      public ToolUse.DataStoreToolTraceOrBuilder getDataStoreToolTraceOrBuilder()
       Optional. Data store tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.DataStoreToolTrace data_store_tool_trace = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDataStoreToolTraceOrBuilder in interface ToolUseOrBuilder

    • hasWebhookToolTrace

      public boolean hasWebhookToolTrace()
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWebhookToolTrace in interface ToolUseOrBuilder
      Returns:
      Whether the webhookToolTrace field is set.

    • getWebhookToolTrace

      public ToolUse.WebhookToolTrace getWebhookToolTrace()
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookToolTrace in interface ToolUseOrBuilder
      Returns:
      The webhookToolTrace.

    • setWebhookToolTrace

      public ToolUse.Builder setWebhookToolTrace(ToolUse.WebhookToolTrace value)
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

    • setWebhookToolTrace

      public ToolUse.Builder setWebhookToolTrace(ToolUse.WebhookToolTrace.Builder builderForValue)
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

    • mergeWebhookToolTrace

      public ToolUse.Builder mergeWebhookToolTrace(ToolUse.WebhookToolTrace value)
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

    • clearWebhookToolTrace

      public ToolUse.Builder clearWebhookToolTrace()
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getWebhookToolTraceBuilder

      public ToolUse.WebhookToolTrace.Builder getWebhookToolTraceBuilder()
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getWebhookToolTraceOrBuilder

      public ToolUse.WebhookToolTraceOrBuilder getWebhookToolTraceOrBuilder()
       Optional. Webhook tool trace.
      .google.cloud.dialogflow.cx.v3beta1.ToolUse.WebhookToolTrace webhook_tool_trace = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebhookToolTraceOrBuilder in interface ToolUseOrBuilder