Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1FormParameter

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) ⇒ GoogleCloudDialogflowCxV3beta1FormParameter

Returns a new instance of GoogleCloudDialogflowCxV3beta1FormParameter.



8313
8314
8315
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8313

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#advanced_settings ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1AdvancedSettings

Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. Corresponds to the JSON property advancedSettings

Returns:



8264
8265
8266
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8264

def advanced_settings
  @advanced_settings
end

#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) 


8270
8271
8272
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8270

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) 


8275
8276
8277
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8275

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) 


8283
8284
8285
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8283

def entity_type
  @entity_type
end

#fill_behavior ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior

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

Returns:



8288
8289
8290
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8288

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) 


8293
8294
8295
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8293

def is_list
  @is_list
end

#redact ⇒ Boolean Also known as: redact?

Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. Corresponds to the JSON property redact

Returns:

  • (Boolean) 


8302
8303
8304
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8302

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) 


8310
8311
8312
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8310

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 8318

def update!(**args)
  @advanced_settings = args[:advanced_settings] if args.key?(:advanced_settings)
  @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