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

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 parameter information.

Defined Under Namespace

Modules: ParameterState

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.

Returns:

  • (::String) —

    Always present for WebhookRequest. Required for WebhookResponse. The human-readable name of the parameter, unique within the form. This field cannot be modified by the webhook.



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 497

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

#just_collected ⇒ ::Boolean

Returns Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.

Returns:

  • (::Boolean) —

    Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn.



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 497

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

#required ⇒ ::Boolean

Returns Optional for both WebhookRequest and 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.

Returns:

  • (::Boolean) —

    Optional for both WebhookRequest and 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.



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 497

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

#state ⇒ ::Google::Cloud::Dialogflow::CX::V3::PageInfo::FormInfo::ParameterInfo::ParameterState

Returns Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored.

Returns:



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 497

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

#value ⇒ ::Google::Protobuf::Value

Returns Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value.

Returns:



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/webhook.rb', line 497

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