Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3TransitionRoute

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

Overview

A transition route specifies a intent that can be matched and/or a data condition that can be evaluated during a session. When a specified transition is matched, the following actions are taken in order: * If there is a trigger_fulfillment associated with the transition, it will be called. * If there is a target_page associated with the transition, the session will transition into the specified page. * If there is a target_flow associated with the transition, the session will transition into the specified flow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3TransitionRoute

Returns a new instance of GoogleCloudDialogflowCxV3TransitionRoute.



3228
3229
3230
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3228

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

Instance Attribute Details

#condition ⇒ String

The condition to evaluate against form parameters or session parameters. See the conditions reference. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. Corresponds to the JSON property condition

Returns:

  • (String) 


3183
3184
3185
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3183

def condition
  @condition
end

#description ⇒ String

Optional. The description of the transition route. The maximum length is 500 characters. Corresponds to the JSON property description

Returns:

  • (String) 


3189
3190
3191
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3189

def description
  @description
end

#intent ⇒ String

The unique identifier of an Intent. Format: projects//locations//agents// intents/. Indicates that the transition can only happen when the given intent is matched. At least one of intent or condition must be specified. When both intent and condition are specified, the transition can only happen when both are fulfilled. Corresponds to the JSON property intent

Returns:

  • (String) 


3198
3199
3200
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3198

def intent
  @intent
end

#name ⇒ String

Output only. The unique identifier of this transition route. Corresponds to the JSON property name

Returns:

  • (String) 


3203
3204
3205
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3203

def name
  @name
end

#target_flow ⇒ String

The target flow to transition to. Format: projects//locations//agents//flows/ . Corresponds to the JSON property targetFlow

Returns:

  • (String) 


3209
3210
3211
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3209

def target_flow
  @target_flow
end

#target_page ⇒ String

The target page to transition to. Format: projects//locations//agents//flows// pages/. Corresponds to the JSON property targetPage

Returns:

  • (String) 


3215
3216
3217
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3215

def target_page
  @target_page
end

#trigger_fulfillment ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3Fulfillment

A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. Corresponds to the JSON property triggerFulfillment

Returns:



3226
3227
3228
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3226

def trigger_fulfillment
  @trigger_fulfillment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3233
3234
3235
3236
3237
3238
3239
3240
3241
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 3233

def update!(**args)
  @condition = args[:condition] if args.key?(:condition)
  @description = args[:description] if args.key?(:description)
  @intent = args[:intent] if args.key?(:intent)
  @name = args[:name] if args.key?(:name)
  @target_flow = args[:target_flow] if args.key?(:target_flow)
  @target_page = args[:target_page] if args.key?(:target_page)
  @trigger_fulfillment = args[:trigger_fulfillment] if args.key?(:trigger_fulfillment)
end