Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo

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 parameter information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo

Returns a new instance of GoogleCloudDialogflowCxV3PageInfoFormInfoParameterInfo.



1941
1942
1943
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1941

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

Instance Attribute Details

#display_name ⇒ String

Always present for WebhookRequest. Required for WebhookResponse. The human- readable name of the parameter, unique within the form. This field cannot be modified by the webhook. Corresponds to the JSON property displayName

Returns:

  • (String) 


1910
1911
1912
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1910

def display_name
  @display_name
end

#just_collected ⇒ Boolean Also known as: just_collected?

Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the parameter value was just collected on the last conversation turn. Corresponds to the JSON property justCollected

Returns:

  • (Boolean) 


1916
1917
1918
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1916

def just_collected
  @just_collected
end

#required ⇒ Boolean Also known as: required?

Optional for both WebhookRequest and WebhookResponse. 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) 


1925
1926
1927
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1925

def required
  @required
end

#state ⇒ String

Always present for WebhookRequest. Required for WebhookResponse. The state of the parameter. This field can be set to INVALID by the webhook to invalidate the parameter; other values set by the webhook will be ignored. Corresponds to the JSON property state

Returns:

  • (String) 


1933
1934
1935
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1933

def state
  @state
end

#value ⇒ Object

Optional for both WebhookRequest and WebhookResponse. The value of the parameter. This field can be set by the webhook to change the parameter value. Corresponds to the JSON property value

Returns:

  • (Object) 


1939
1940
1941
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1939

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1946
1947
1948
1949
1950
1951
1952
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 1946

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @just_collected = args[:just_collected] if args.key?(:just_collected)
  @required = args[:required] if args.key?(:required)
  @state = args[:state] if args.key?(:state)
  @value = args[:value] if args.key?(:value)
end