Class TransitionRoute (0.66.0) 

public final class TransitionRoute extends GeneratedMessageV3 implements TransitionRouteOrBuilder

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.

Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRoute

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransitionRoute

Static Fields

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

INTENT_FIELD_NUMBER

public static final int INTENT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FLOW_FIELD_NUMBER

public static final int TARGET_FLOW_FIELD_NUMBER
Field Value
Type Description
int

TARGET_PAGE_FIELD_NUMBER

public static final int TARGET_PAGE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_FULFILLMENT_FIELD_NUMBER

public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransitionRoute getDefaultInstance()
Returns
Type Description
TransitionRoute

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransitionRoute.Builder newBuilder()
Returns
Type Description
TransitionRoute.Builder

newBuilder(TransitionRoute prototype)

public static TransitionRoute.Builder newBuilder(TransitionRoute prototype)
Parameter
Name Description
prototype TransitionRoute
Returns
Type Description
TransitionRoute.Builder

parseDelimitedFrom(InputStream input)

public static TransitionRoute parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransitionRoute parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransitionRoute parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransitionRoute parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransitionRoute parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransitionRoute parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransitionRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransitionRoute> parser()
Returns
Type Description
Parser<TransitionRoute>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCondition()

public String getCondition()

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.

string condition = 2;

Returns
Type Description
String

The condition.

getConditionBytes()

public ByteString getConditionBytes()

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.

string condition = 2;

Returns
Type Description
ByteString

The bytes for condition.

getDefaultInstanceForType()

public TransitionRoute getDefaultInstanceForType()
Returns
Type Description
TransitionRoute

getDescription()

public String getDescription()

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

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getIntent()

public String getIntent()

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.

string intent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The intent.

getIntentBytes()

public ByteString getIntentBytes()

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.

string intent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for intent.

getName()

public String getName()

Output only. The unique identifier of this transition route.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The unique identifier of this transition route.

string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<TransitionRoute> getParserForType()
Returns
Type Description
Parser<TransitionRoute>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetCase()

public TransitionRoute.TargetCase getTargetCase()
Returns
Type Description
TransitionRoute.TargetCase

getTargetFlow()

public String getTargetFlow()

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

string target_flow = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The targetFlow.

getTargetFlowBytes()

public ByteString getTargetFlowBytes()

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

string target_flow = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for targetFlow.

getTargetPage()

public String getTargetPage()

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

string target_page = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The targetPage.

getTargetPageBytes()

public ByteString getTargetPageBytes()

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

string target_page = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for targetPage.

getTriggerFulfillment()

public Fulfillment getTriggerFulfillment()

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.

.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
Fulfillment

The triggerFulfillment.

getTriggerFulfillmentOrBuilder()

public FulfillmentOrBuilder getTriggerFulfillmentOrBuilder()

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.

.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
FulfillmentOrBuilder

hasTargetFlow()

public boolean hasTargetFlow()

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

string target_flow = 5 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the targetFlow field is set.

hasTargetPage()

public boolean hasTargetPage()

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

string target_page = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the targetPage field is set.

hasTriggerFulfillment()

public boolean hasTriggerFulfillment()

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.

.google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;

Returns
Type Description
boolean

Whether the triggerFulfillment field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransitionRoute.Builder newBuilderForType()
Returns
Type Description
TransitionRoute.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransitionRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransitionRoute.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransitionRoute.Builder toBuilder()
Returns
Type Description
TransitionRoute.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException