Class: Google::Cloud::Dialogflow::CX::V3::TransitionRoute

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/page.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 Attribute Details

#condition ⇒ ::String

Returns The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.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.

Returns:

  • (::String) —

    The condition to evaluate against [form parameters][google.cloud.dialogflow.cx.v3.Form.parameters] or [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.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.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns Optional. The description of the transition route. The maximum length is 500 characters.

Returns:

  • (::String) —

    Optional. The description of the transition route. The maximum length is 500 characters.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#intent ⇒ ::String

Returns The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. 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.

Returns:

  • (::String) —

    The unique identifier of an Intent. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>. 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.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String (readonly)

Returns Output only. The unique identifier of this transition route.

Returns:

  • (::String) —

    Output only. The unique identifier of this transition route.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_flow ⇒ ::String

Returns The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

    Note: The following fields are mutually exclusive: target_flow, target_page. If a field in that set is populated, all other fields in the set will automatically be cleared.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_page ⇒ ::String

Returns The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

    Note: The following fields are mutually exclusive: target_page, target_flow. If a field in that set is populated, all other fields in the set will automatically be cleared.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#trigger_fulfillment ⇒ ::Google::Cloud::Dialogflow::CX::V3::Fulfillment

Returns The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.

Returns:

  • (::Google::Cloud::Dialogflow::CX::V3::Fulfillment) —

    The fulfillment to call when the condition is satisfied. At least one of trigger_fulfillment and target must be specified. When both are defined, trigger_fulfillment is executed first.



337
338
339
340
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/page.rb', line 337

class TransitionRoute
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end