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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

Returns:

  • (::String) —

    Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the current page. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 410

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:



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 410

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:



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 410

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