Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FormParameter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3beta1/classes.rb,
lib/google/apis/dialogflow_v3beta1/representations.rb,
lib/google/apis/dialogflow_v3beta1/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.



3729
3730
3731
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3729

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) 


3687
3688
3689
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3687

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) 


3692
3693
3694
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3692

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) 


3700
3701
3702
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3700

def entity_type
  @entity_type
end

#fill_behavior ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior

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

Returns:



3705
3706
3707
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3705

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) 


3710
3711
3712
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3710

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) 


3718
3719
3720
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3718

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) 


3726
3727
3728
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3726

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3734
3735
3736
3737
3738
3739
3740
3741
3742
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 3734

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