Package com.google.cloud.dialogflow.v2

Class ToolCall

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.ToolCall
All Implemented Interfaces:
ToolCallOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ToolCall extends com.google.protobuf.GeneratedMessage implements ToolCallOrBuilder
 Represents a call of a specific tool's action with the specified inputs.
Protobuf type google.cloud.dialogflow.v2.ToolCall
See Also:

  • Field Details

    • TOOL_FIELD_NUMBER

      public static final int TOOL_FIELD_NUMBER
      See Also:

    • CES_TOOL_FIELD_NUMBER

      public static final int CES_TOOL_FIELD_NUMBER
      See Also:

    • CES_TOOLSET_FIELD_NUMBER

      public static final int CES_TOOLSET_FIELD_NUMBER
      See Also:

    • CES_APP_FIELD_NUMBER

      public static final int CES_APP_FIELD_NUMBER
      See Also:

    • TOOL_DISPLAY_NAME_FIELD_NUMBER

      public static final int TOOL_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • TOOL_DISPLAY_DETAILS_FIELD_NUMBER

      public static final int TOOL_DISPLAY_DETAILS_FIELD_NUMBER
      See Also:

    • ACTION_FIELD_NUMBER

      public static final int ACTION_FIELD_NUMBER
      See Also:

    • INPUT_PARAMETERS_FIELD_NUMBER

      public static final int INPUT_PARAMETERS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • ANSWER_RECORD_FIELD_NUMBER

      public static final int ANSWER_RECORD_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

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

    • getSourceCase

      public ToolCall.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface ToolCallOrBuilder

    • hasTool

      public boolean hasTool()
       Optional. The [tool][google.cloud.dialogflow.v2.Tool] associated with
 this call. Format:
 `projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>`.
      string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      hasTool in interface ToolCallOrBuilder
      Returns:
      Whether the tool field is set.

    • getTool

      public String getTool()
       Optional. The [tool][google.cloud.dialogflow.v2.Tool] associated with
 this call. Format:
 `projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>`.
      string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getTool in interface ToolCallOrBuilder
      Returns:
      The tool.

    • getToolBytes

      public com.google.protobuf.ByteString getToolBytes()
       Optional. The [tool][google.cloud.dialogflow.v2.Tool] associated with
 this call. Format:
 `projects/<ProjectID>/locations/<LocationID>/tools/<ToolID>`.
      string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getToolBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for tool.

    • hasCesTool

      public boolean hasCesTool()
       Optional. CES tool name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>`.
      string ces_tool = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      hasCesTool in interface ToolCallOrBuilder
      Returns:
      Whether the cesTool field is set.

    • getCesTool

      public String getCesTool()
       Optional. CES tool name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>`.
      string ces_tool = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesTool in interface ToolCallOrBuilder
      Returns:
      The cesTool.

    • getCesToolBytes

      public com.google.protobuf.ByteString getCesToolBytes()
       Optional. CES tool name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/tools/<ToolID>`.
      string ces_tool = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesToolBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for cesTool.

    • hasCesToolset

      public boolean hasCesToolset()
       Optional. CES toolset name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>`.
      string ces_toolset = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      hasCesToolset in interface ToolCallOrBuilder
      Returns:
      Whether the cesToolset field is set.

    • getCesToolset

      public String getCesToolset()
       Optional. CES toolset name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>`.
      string ces_toolset = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesToolset in interface ToolCallOrBuilder
      Returns:
      The cesToolset.

    • getCesToolsetBytes

      public com.google.protobuf.ByteString getCesToolsetBytes()
       Optional. CES toolset name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>/toolsets/ToolsetID>`.
      string ces_toolset = 12 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesToolsetBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for cesToolset.

    • hasCesApp

      public boolean hasCesApp()
       Optional. CES app name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>`.
      string ces_app = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      hasCesApp in interface ToolCallOrBuilder
      Returns:
      Whether the cesApp field is set.

    • getCesApp

      public String getCesApp()
       Optional. CES app name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>`.
      string ces_app = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesApp in interface ToolCallOrBuilder
      Returns:
      The cesApp.

    • getCesAppBytes

      public com.google.protobuf.ByteString getCesAppBytes()
       Optional. CES app name for this call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/apps/<AppID>`.
      string ces_app = 8 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCesAppBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for cesApp.

    • getToolDisplayName

      public String getToolDisplayName()
       Optional. A human readable short name of the tool, to be shown on the UI.
      string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolDisplayName in interface ToolCallOrBuilder
      Returns:
      The toolDisplayName.

    • getToolDisplayNameBytes

      public com.google.protobuf.ByteString getToolDisplayNameBytes()
       Optional. A human readable short name of the tool, to be shown on the UI.
      string tool_display_name = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolDisplayNameBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for toolDisplayName.

    • getToolDisplayDetails

      public String getToolDisplayDetails()
       Optional. A human readable description of the tool.
      string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolDisplayDetails in interface ToolCallOrBuilder
      Returns:
      The toolDisplayDetails.

    • getToolDisplayDetailsBytes

      public com.google.protobuf.ByteString getToolDisplayDetailsBytes()
       Optional. A human readable description of the tool.
      string tool_display_details = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolDisplayDetailsBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for toolDisplayDetails.

    • getAction

      public String getAction()
       Optional. The name of the tool's action associated with this call.
      string action = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAction in interface ToolCallOrBuilder
      Returns:
      The action.

    • getActionBytes

      public com.google.protobuf.ByteString getActionBytes()
       Optional. The name of the tool's action associated with this call.
      string action = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getActionBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for action.

    • hasInputParameters

      public boolean hasInputParameters()
       Optional. The action's input parameters.
      .google.protobuf.Struct input_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasInputParameters in interface ToolCallOrBuilder
      Returns:
      Whether the inputParameters field is set.

    • getInputParameters

      public com.google.protobuf.Struct getInputParameters()
       Optional. The action's input parameters.
      .google.protobuf.Struct input_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInputParameters in interface ToolCallOrBuilder
      Returns:
      The inputParameters.

    • getInputParametersOrBuilder

      public com.google.protobuf.StructOrBuilder getInputParametersOrBuilder()
       Optional. The action's input parameters.
      .google.protobuf.Struct input_parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInputParametersOrBuilder in interface ToolCallOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Create time of the tool call.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ToolCallOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Create time of the tool call.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ToolCallOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Create time of the tool call.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ToolCallOrBuilder

    • getAnswerRecord

      public String getAnswerRecord()
       Optional. The answer record associated with this tool call.
      string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerRecord in interface ToolCallOrBuilder
      Returns:
      The answerRecord.

    • getAnswerRecordBytes

      public com.google.protobuf.ByteString getAnswerRecordBytes()
       Optional. The answer record associated with this tool call.
      string answer_record = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerRecordBytes in interface ToolCallOrBuilder
      Returns:
      The bytes for answerRecord.

    • getStateValue

      public int getStateValue()
       Output only. State of the tool call.
      .google.cloud.dialogflow.v2.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface ToolCallOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public ToolCall.State getState()
       Output only. State of the tool call.
      .google.cloud.dialogflow.v2.ToolCall.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface ToolCallOrBuilder
      Returns:
      The state.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ToolCall.Builder newBuilder()

    • newBuilder

      public static ToolCall.Builder newBuilder(ToolCall prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ToolCall getDefaultInstance()

    • parser

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

    • getParserForType

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