Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentParameter
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentParameter
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/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) ⇒ GoogleCloudDialogflowV2IntentParameter
constructor
A new instance of GoogleCloudDialogflowV2IntentParameter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2IntentParameter
Returns a new instance of GoogleCloudDialogflowV2IntentParameter
1089 1090 1091 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1089 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
1040 1041 1042 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1040 def default_value @default_value end |
#display_name ⇒ String
Required. The name of the parameter.
Corresponds to the JSON property displayName
1045 1046 1047 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1045 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
1052 1053 1054 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1052 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
1057 1058 1059 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1057 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
1065 1066 1067 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1065 def mandatory @mandatory end |
#name ⇒ String
The unique identifier of this parameter.
Corresponds to the JSON property name
1071 1072 1073 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1071 def name @name end |
#prompts ⇒ Array<String>
Optional. The collection of prompts that the agent can present to the
user in order to collect value for the parameter.
Corresponds to the JSON property prompts
1077 1078 1079 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1077 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
1087 1088 1089 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1087 def value @value end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 1094 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 |