Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents parameter information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo

Returns a new instance of GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo.



4694
4695
4696
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4694

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_nameString

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. Corresponds to the JSON property displayName

Returns:

  • (String)


4663
4664
4665
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4663

def display_name
  @display_name
end

#just_collectedBoolean Also known as: just_collected?

Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn. Corresponds to the JSON property justCollected

Returns:

  • (Boolean)


4669
4670
4671
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4669

def just_collected
  @just_collected
end

#requiredBoolean Also known as: required?

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. Corresponds to the JSON property required

Returns:

  • (Boolean)


4678
4679
4680
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4678

def required
  @required
end

#stateString

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. Corresponds to the JSON property state

Returns:

  • (String)


4686
4687
4688
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4686

def state
  @state
end

#valueObject

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

Returns:

  • (Object)


4692
4693
4694
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4692

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4699
4700
4701
4702
4703
4704
4705
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 4699

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @just_collected = args[:just_collected] if args.key?(:just_collected)
  @required = args[:required] if args.key?(:required)
  @state = args[:state] if args.key?(:state)
  @value = args[:value] if args.key?(:value)
end