Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3FormParameter

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

Returns a new instance of GoogleCloudDialogflowCxV3FormParameter.



971
972
973
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 971

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

Instance Attribute Details

#advanced_settings ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3AdvancedSettings

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:



922
923
924
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 922

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) 


928
929
930
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 928

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) 


933
934
935
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 933

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) 


941
942
943
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 941

def entity_type
  @entity_type
end

#fill_behavior ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3FormParameterFillBehavior

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

Returns:



946
947
948
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 946

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) 


951
952
953
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 951

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) 


960
961
962
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 960

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) 


968
969
970
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 968

def required
  @required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



976
977
978
979
980
981
982
983
984
985
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 976

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