Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FormParameter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Represents a form parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3FormParameter

Returns a new instance of GoogleCloudDialogflowCxV3FormParameter.



1422
1423
1424
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1422

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

Returns:

  • (Object) 


1380
1381
1382
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1380

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

Returns:

  • (String) 


1385
1386
1387
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1385

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

Returns:

  • (String) 


1393
1394
1395
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1393

def entity_type
  @entity_type
end

#fill_behavior ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3FormParameterFillBehavior

Configuration for how the filling of a parameter should be handled. Corresponds to the JSON property fillBehavior

Returns:



1398
1399
1400
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1398

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

Returns:

  • (Boolean) 


1403
1404
1405
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1403

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

Returns:

  • (Boolean) 


1411
1412
1413
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1411

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

Returns:

  • (Boolean) 


1419
1420
1421
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1419

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1427
1428
1429
1430
1431
1432
1433
1434
1435
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 1427

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