Class: Google::Cloud::Dialogflow::CX::V3::WebhookResponse

Inherits:

Object

• Object
• Google::Cloud::Dialogflow::CX::V3::WebhookResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb

Overview

The response message for a webhook call.

Defined Under Namespace

Classes: FulfillmentResponse

Instance Attribute Summary

• #fulfillment_response ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse

  The fulfillment response to send to the user.

• #page_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo

  Information about page status.

• #payload ⇒ ::Google::Protobuf::Struct

  Value to append directly to QueryResult.webhook_payloads.

• #session_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

  Information about session status.

• #target_flow ⇒ ::String

  The target flow to transition to.

• #target_page ⇒ ::String

  The target page to transition to.

Instance Attribute Details

#fulfillment_response ⇒ ::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end

#page_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end

#payload ⇒ ::Google::Protobuf::Struct

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end

#session_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::SessionInfo

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end

#target_flow ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end

#target_page ⇒ ::String

# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 533

class WebhookResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a fulfillment response to the user.
  # @!attribute [rw] messages
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage>]
  #     The list of rich message responses to present to the user.
  # @!attribute [rw] merge_behavior
  #   @return [::Google::Cloud::Dialogflow::CX::V3::WebhookResponse::FulfillmentResponse::MergeBehavior]
  #     Merge behavior for `messages`.
  class FulfillmentResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines merge behavior for `messages`.
    module MergeBehavior
      # Not specified. `APPEND` will be used.
      MERGE_BEHAVIOR_UNSPECIFIED = 0

      # `messages` will be appended to the list of messages waiting to be sent
      # to the user.
      APPEND = 1

      # `messages` will replace the list of messages waiting to be sent to the
      # user.
      REPLACE = 2
    end
  end
end