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.v3.TransitionRoute
Static Fields
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value
INTENT_FIELD_NUMBER
public static final int INTENT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
TARGET_FLOW_FIELD_NUMBER
public static final int TARGET_FLOW_FIELD_NUMBER
Field Value
TARGET_PAGE_FIELD_NUMBER
public static final int TARGET_PAGE_FIELD_NUMBER
Field Value
TRIGGER_FULFILLMENT_FIELD_NUMBER
public static final int TRIGGER_FULFILLMENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TransitionRoute getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TransitionRoute.Builder newBuilder()
Returns
newBuilder(TransitionRoute prototype)
public static TransitionRoute.Builder newBuilder(TransitionRoute prototype)
Parameter
Returns
public static TransitionRoute parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransitionRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TransitionRoute parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransitionRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TransitionRoute parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransitionRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransitionRoute parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TransitionRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TransitionRoute parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TransitionRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TransitionRoute parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransitionRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TransitionRoute> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
getIntent()
public String getIntent()
The unique identifier of an Intent.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>
.
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/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/intents/<Intent ID>
.
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
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
getParserForType()
public Parser<TransitionRoute> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetCase()
public TransitionRoute.TargetCase getTargetCase()
Returns
getTargetFlow()
public String getTargetFlow()
The target flow to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
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/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
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/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
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/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
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.v3.Fulfillment trigger_fulfillment = 3;
Returns
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.v3.Fulfillment trigger_fulfillment = 3;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasTargetFlow()
public boolean hasTargetFlow()
The target flow to transition to.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>
.
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/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>/pages/<Page ID>
.
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.v3.Fulfillment trigger_fulfillment = 3;
Returns
Type |
Description |
boolean |
Whether the triggerFulfillment field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TransitionRoute.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransitionRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TransitionRoute.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions