Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentParameter
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentParameter
- 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 intent parameters.
Instance Attribute Summary collapse
-
#default_value ⇒ String
Optional.
-
#display_name ⇒ String
Required.
-
#entity_type_display_name ⇒ String
Optional.
-
#is_list ⇒ Boolean
(also: #is_list?)
Optional.
-
#mandatory ⇒ Boolean
(also: #mandatory?)
Optional.
-
#name ⇒ String
The unique identifier of this parameter.
-
#prompts ⇒ Array<String>
Optional.
-
#value ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1IntentParameter
constructor
A new instance of GoogleCloudDialogflowV2beta1IntentParameter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1IntentParameter
Returns a new instance of GoogleCloudDialogflowV2beta1IntentParameter.
5642 5643 5644 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5642 def initialize(**args) update!(**args) end |
Instance Attribute Details
#default_value ⇒ String
Optional. The default value to use when the value
yields an empty
result.
Default values can be extracted from contexts by using the following
syntax: #context_name.parameter_name
.
Corresponds to the JSON property defaultValue
5593 5594 5595 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5593 def default_value @default_value end |
#display_name ⇒ String
Required. The name of the parameter.
Corresponds to the JSON property displayName
5598 5599 5600 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5598 def display_name @display_name end |
#entity_type_display_name ⇒ String
Optional. The name of the entity type, prefixed with @
, that
describes values of the parameter. If the parameter is
required, this must be provided.
Corresponds to the JSON property entityTypeDisplayName
5605 5606 5607 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5605 def entity_type_display_name @entity_type_display_name end |
#is_list ⇒ Boolean Also known as: is_list?
Optional. Indicates whether the parameter represents a list of values.
Corresponds to the JSON property isList
5610 5611 5612 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5610 def is_list @is_list end |
#mandatory ⇒ Boolean Also known as: mandatory?
Optional. Indicates whether the parameter is required. That is,
whether the intent cannot be completed without collecting the parameter
value.
Corresponds to the JSON property mandatory
5618 5619 5620 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5618 def mandatory @mandatory end |
#name ⇒ String
The unique identifier of this parameter.
Corresponds to the JSON property name
5624 5625 5626 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5624 def name @name end |
#prompts ⇒ Array<String>
Optional. The collection of prompts that the agent can present to the
user in order to collect a value for the parameter.
Corresponds to the JSON property prompts
5630 5631 5632 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5630 def prompts @prompts end |
#value ⇒ String
Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name
, - an original parameter value defined as
$parameter_name.original
, - a parameter value from some context defined as
#context_name.parameter_name
. Corresponds to the JSON propertyvalue
5640 5641 5642 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5640 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 |
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 5647 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_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) @is_list = args[:is_list] if args.key?(:is_list) @mandatory = args[:mandatory] if args.key?(:mandatory) @name = args[:name] if args.key?(:name) @prompts = args[:prompts] if args.key?(:prompts) @value = args[:value] if args.key?(:value) end |