Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/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.



10166
10167
10168
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10166

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

Instance Attribute Details

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

Returns:

  • (String) 


10135
10136
10137
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10135

def display_name
  @display_name
end

#just_collected ⇒ Boolean 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) 


10141
10142
10143
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10141

def just_collected
  @just_collected
end

#required ⇒ Boolean 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) 


10150
10151
10152
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10150

def required
  @required
end

#state ⇒ String

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) 


10158
10159
10160
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10158

def state
  @state
end

#value ⇒ Object

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) 


10164
10165
10166
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10164

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10171
10172
10173
10174
10175
10176
10177
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 10171

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