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

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



1115
1116
1117
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1115

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) 


1073
1074
1075
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1073

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) 


1078
1079
1080
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1078

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) 


1086
1087
1088
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1086

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:



1091
1092
1093
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1091

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) 


1096
1097
1098
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1096

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) 


1104
1105
1106
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1104

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) 


1112
1113
1114
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1112

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1120
1121
1122
1123
1124
1125
1126
1127
1128
 
# File 'generated/google/apis/dialogflow_v3/classes.rb', line 1120

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