Class: Google::Cloud::Dialogflow::CX::V3::PageInfo

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

Represents page information communicated to and from the webhook.

Defined Under Namespace

Classes: FormInfo

Instance Attribute Summary collapse

Instance Attribute Details

#current_page ⇒ ::String

Returns Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Returns:

  • (::String) —

    Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 567

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

  # Represents form information.
  # @!attribute [rw] parameter_info
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo>]
  #     Optional for both
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
  #     parameters contained in the form. Note that the webhook cannot add or
  #     remove any form parameter.
  class FormInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents parameter information.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     The human-readable name of the parameter, unique within the form. This
    #     field cannot be modified by the webhook.
    # @!attribute [rw] required
    #   @return [::Boolean]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates whether the parameter is required. Optional parameters will
    #     not trigger prompts; however, they are filled if the user specifies
    #     them. Required parameters must be filled before form filling concludes.
    # @!attribute [rw] state
    #   @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     state of the parameter. This field can be set to
    #     {::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID INVALID}
    #     by the webhook to invalidate the parameter; other values set by the
    #     webhook will be ignored.
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     value of the parameter. This field can be set by the webhook to change
    #     the parameter value.
    # @!attribute [rw] just_collected
    #   @return [::Boolean]
    #     Optional for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored
    #     for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates if the parameter value was just collected on the last
    #     conversation turn.
    class ParameterInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the state of a parameter.
      module ParameterState
        # Not specified. This value should be never used.
        PARAMETER_STATE_UNSPECIFIED = 0

        # Indicates that the parameter does not have a value.
        EMPTY = 1

        # Indicates that the parameter value is invalid. This field can be used
        # by the webhook to invalidate the parameter and ask the server to
        # collect it from the user again.
        INVALID = 2

        # Indicates that the parameter has a value.
        FILLED = 3
      end
    end
  end
end

#display_name ⇒ ::String

Returns Always present for WebhookRequest. Ignored for WebhookResponse. The display name of the current page.

Returns:



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 567

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

  # Represents form information.
  # @!attribute [rw] parameter_info
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo>]
  #     Optional for both
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
  #     parameters contained in the form. Note that the webhook cannot add or
  #     remove any form parameter.
  class FormInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents parameter information.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     The human-readable name of the parameter, unique within the form. This
    #     field cannot be modified by the webhook.
    # @!attribute [rw] required
    #   @return [::Boolean]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates whether the parameter is required. Optional parameters will
    #     not trigger prompts; however, they are filled if the user specifies
    #     them. Required parameters must be filled before form filling concludes.
    # @!attribute [rw] state
    #   @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     state of the parameter. This field can be set to
    #     {::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID INVALID}
    #     by the webhook to invalidate the parameter; other values set by the
    #     webhook will be ignored.
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     value of the parameter. This field can be set by the webhook to change
    #     the parameter value.
    # @!attribute [rw] just_collected
    #   @return [::Boolean]
    #     Optional for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored
    #     for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates if the parameter value was just collected on the last
    #     conversation turn.
    class ParameterInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the state of a parameter.
      module ParameterState
        # Not specified. This value should be never used.
        PARAMETER_STATE_UNSPECIFIED = 0

        # Indicates that the parameter does not have a value.
        EMPTY = 1

        # Indicates that the parameter value is invalid. This field can be used
        # by the webhook to invalidate the parameter and ask the server to
        # collect it from the user again.
        INVALID = 2

        # Indicates that the parameter has a value.
        FILLED = 3
      end
    end
  end
end

#form_info ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo

Returns Optional for both WebhookRequest and WebhookResponse. Information about the form.

Returns:



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 567

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

  # Represents form information.
  # @!attribute [rw] parameter_info
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo>]
  #     Optional for both
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
  #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
  #     parameters contained in the form. Note that the webhook cannot add or
  #     remove any form parameter.
  class FormInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents parameter information.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     The human-readable name of the parameter, unique within the form. This
    #     field cannot be modified by the webhook.
    # @!attribute [rw] required
    #   @return [::Boolean]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates whether the parameter is required. Optional parameters will
    #     not trigger prompts; however, they are filled if the user specifies
    #     them. Required parameters must be filled before form filling concludes.
    # @!attribute [rw] state
    #   @return [::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState]
    #     Always present for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}.
    #     Required for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     state of the parameter. This field can be set to
    #     {::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState::INVALID INVALID}
    #     by the webhook to invalidate the parameter; other values set by the
    #     webhook will be ignored.
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    #     Optional for both
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest} and
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}. The
    #     value of the parameter. This field can be set by the webhook to change
    #     the parameter value.
    # @!attribute [rw] just_collected
    #   @return [::Boolean]
    #     Optional for
    #     {::Google::Cloud::Dialogflow::CX::V3::WebhookRequest WebhookRequest}. Ignored
    #     for {::Google::Cloud::Dialogflow::CX::V3::WebhookResponse WebhookResponse}.
    #     Indicates if the parameter value was just collected on the last
    #     conversation turn.
    class ParameterInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Represents the state of a parameter.
      module ParameterState
        # Not specified. This value should be never used.
        PARAMETER_STATE_UNSPECIFIED = 0

        # Indicates that the parameter does not have a value.
        EMPTY = 1

        # Indicates that the parameter value is invalid. This field can be used
        # by the webhook to invalidate the parameter and ask the server to
        # collect it from the user again.
        INVALID = 2

        # Indicates that the parameter has a value.
        FILLED = 3
      end
    end
  end
end