Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentParameter

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2IntentParameter

Returns a new instance of GoogleCloudDialogflowV2IntentParameter.



2269
2270
2271
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2269

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

Returns:

  • (String) 


2220
2221
2222
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2220

def default_value
  @default_value
end

#display_name ⇒ String

Required. The name of the parameter. Corresponds to the JSON property displayName

Returns:

  • (String) 


2225
2226
2227
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2225

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

Returns:

  • (String) 


2232
2233
2234
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2232

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

Returns:

  • (Boolean) 


2237
2238
2239
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2237

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

Returns:

  • (Boolean) 


2245
2246
2247
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2245

def mandatory
  @mandatory
end

#name ⇒ String

The unique identifier of this parameter. Corresponds to the JSON property name

Returns:

  • (String) 


2251
2252
2253
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2251

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

Returns:

  • (Array<String>) 


2257
2258
2259
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2257

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 property value

Returns:

  • (String) 


2267
2268
2269
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2267

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 2274

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