Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1FormParameter
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1FormParameter
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dialogflow_v2/classes.rb,
lib/google/apis/dialogflow_v2/representations.rb,
lib/google/apis/dialogflow_v2/representations.rb
Overview
Represents a form parameter.
Instance Attribute Summary collapse
-
#advanced_settings ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1AdvancedSettings
Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
-
#default_value ⇒ Object
The default value of an optional parameter.
-
#display_name ⇒ String
Required.
-
#entity_type ⇒ String
Required.
-
#fill_behavior ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
Configuration for how the filling of a parameter should be handled.
-
#is_list ⇒ Boolean
(also: #is_list?)
Indicates whether the parameter represents a list of values.
-
#redact ⇒ Boolean
(also: #redact?)
Indicates whether the parameter content should be redacted in log.
-
#required ⇒ Boolean
(also: #required?)
Indicates whether the parameter is required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1FormParameter
constructor
A new instance of GoogleCloudDialogflowCxV3beta1FormParameter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1FormParameter
Returns a new instance of GoogleCloudDialogflowCxV3beta1FormParameter.
4996 4997 4998 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4996 def initialize(**args) update!(**args) end |
Instance Attribute Details
#advanced_settings ⇒ Google::Apis::DialogflowV2::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
4947 4948 4949 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4947 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
4953 4954 4955 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4953 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
4958 4959 4960 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4958 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
4966 4967 4968 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4966 def entity_type @entity_type end |
#fill_behavior ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior
Configuration for how the filling of a parameter should be handled.
Corresponds to the JSON property fillBehavior
4971 4972 4973 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4971 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
4976 4977 4978 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4976 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
4985 4986 4987 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4985 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
4993 4994 4995 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 4993 def required @required end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 |
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 5001 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 |