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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

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

Returns The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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

Returns Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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

Returns Value to append directly to QueryResult.webhook_payloads.

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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

Returns Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

Returns:



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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

Returns The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

Returns:

  • (::String) —

    The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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

Returns The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns:

  • (::String) —

    The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 517

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