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

Class ToolUse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.ToolUse
All Implemented Interfaces:
ToolUseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ToolUse extends com.google.protobuf.GeneratedMessage implements ToolUseOrBuilder
 Stores metadata of the invocation of an action supported by a tool.
Protobuf type google.cloud.dialogflow.cx.v3beta1.ToolUse
See Also:

  • Field Details

    • TOOL_FIELD_NUMBER

      public static final int TOOL_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • ACTION_FIELD_NUMBER

      public static final int ACTION_FIELD_NUMBER
      See Also:

    • INPUT_ACTION_PARAMETERS_FIELD_NUMBER

      public static final int INPUT_ACTION_PARAMETERS_FIELD_NUMBER
      See Also:

    • OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER

      public static final int OUTPUT_ACTION_PARAMETERS_FIELD_NUMBER
      See Also:

    • DATA_STORE_TOOL_TRACE_FIELD_NUMBER

      public static final int DATA_STORE_TOOL_TRACE_FIELD_NUMBER
      See Also:

    • WEBHOOK_TOOL_TRACE_FIELD_NUMBER

      public static final int WEBHOOK_TOOL_TRACE_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

    • getToolTraceCase

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

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

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

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

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

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

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

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

    • 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

    • 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 ToolUse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ToolUse.Builder newBuilder()

    • newBuilder

      public static ToolUse.Builder newBuilder(ToolUse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ToolUse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ToolUse> 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 ToolUse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder