Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v3beta1/classes.rb,
generated/google/apis/dialogflow_v3beta1/representations.rb,
generated/google/apis/dialogflow_v3beta1/representations.rb

Overview

Represents parameter information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo

Returns a new instance of GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo.



5005
5006
5007
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 5005

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

Instance Attribute Details

#display_nameString

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)


4974
4975
4976
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 4974

def display_name
  @display_name
end

#just_collectedBoolean 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)


4980
4981
4982
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 4980

def just_collected
  @just_collected
end

#requiredBoolean 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)


4989
4990
4991
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 4989

def required
  @required
end

#stateString

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)


4997
4998
4999
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 4997

def state
  @state
end

#valueObject

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)


5003
5004
5005
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 5003

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5010
5011
5012
5013
5014
5015
5016
# File 'generated/google/apis/dialogflow_v3beta1/classes.rb', line 5010

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