Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FormParameter
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FormParameter
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb
Overview
Represents a form parameter.
Instance Attribute Summary collapse
-
#default_value ⇒ Object
The default value of an optional parameter.
-
#display_name ⇒ String
Required.
-
#entity_type ⇒ String
Required.
-
#fill_behavior ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FormParameterFillBehavior
Configuration for how the filling of a parameter should be handled.
-
#is_list ⇒ Boolean
(also: #is_list?)
Indicates whether the parameter represents a list of values.
-
#redact ⇒ Boolean
(also: #redact?)
Indicates whether the parameter content is logged in text and audio.
-
#required ⇒ Boolean
(also: #required?)
Indicates whether the parameter is required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3FormParameter
constructor
A new instance of GoogleCloudDialogflowCxV3FormParameter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3FormParameter
Returns a new instance of GoogleCloudDialogflowCxV3FormParameter.
531 532 533 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 531 def initialize(**args) update!(**args) end |
Instance Attribute Details
#default_value ⇒ Object
The default value of an optional parameter. If the parameter is required, the
default value will be ignored.
Corresponds to the JSON property defaultValue
489 490 491 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 489 def default_value @default_value end |
#display_name ⇒ String
Required. The human-readable name of the parameter, unique within the form.
Corresponds to the JSON property displayName
494 495 496 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 494 def display_name @display_name end |
#entity_type ⇒ String
Required. The entity type of the parameter. Format: projects/-/locations/-/
agents/-/entityTypes/
for system entity types (for example, projects/-/
locations/-/agents/-/entityTypes/sys.date
), or projects//locations//agents//
entityTypes/
for developer entity types.
Corresponds to the JSON property entityType
502 503 504 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 502 def entity_type @entity_type end |
#fill_behavior ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3FormParameterFillBehavior
Configuration for how the filling of a parameter should be handled.
Corresponds to the JSON property fillBehavior
507 508 509 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 507 def fill_behavior @fill_behavior end |
#is_list ⇒ Boolean Also known as: is_list?
Indicates whether the parameter represents a list of values.
Corresponds to the JSON property isList
512 513 514 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 512 def is_list @is_list end |
#redact ⇒ Boolean Also known as: redact?
Indicates whether the parameter content is logged in text and audio. If it is
set to true, the parameter content will be replaced to parameter name in both
request and response. The default value is false.
Corresponds to the JSON property redact
520 521 522 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 520 def redact @redact end |
#required ⇒ Boolean Also known as: required?
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
528 529 530 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 528 def required @required end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
536 537 538 539 540 541 542 543 544 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 536 def update!(**args) @default_value = args[:default_value] if args.key?(:default_value) @display_name = args[:display_name] if args.key?(:display_name) @entity_type = args[:entity_type] if args.key?(:entity_type) @fill_behavior = args[:fill_behavior] if args.key?(:fill_behavior) @is_list = args[:is_list] if args.key?(:is_list) @redact = args[:redact] if args.key?(:redact) @required = args[:required] if args.key?(:required) end |