Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo

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) ⇒ GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo

Returns a new instance of GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo.



2327
2328
2329
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2327

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) 


2296
2297
2298
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2296

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) 


2302
2303
2304
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2302

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) 


2311
2312
2313
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2311

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) 


2319
2320
2321
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2319

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) 


2325
2326
2327
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2325

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2332
2333
2334
2335
2336
2337
2338
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 2332

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