Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1FormParameter

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



2838
2839
2840
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2838

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) 


2796
2797
2798
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2796

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) 


2801
2802
2803
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2801

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) 


2809
2810
2811
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2809

def entity_type
  @entity_type
end

#fill_behavior ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior

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

Returns:



2814
2815
2816
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2814

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) 


2819
2820
2821
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2819

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) 


2827
2828
2829
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2827

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) 


2835
2836
2837
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2835

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2843
2844
2845
2846
2847
2848
2849
2850
2851
 
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2843

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