Class TransitionRoute.Builder (0.63.0) 

public static final class TransitionRoute.Builder extends GeneratedMessageV3.Builder<TransitionRoute.Builder> 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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransitionRoute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransitionRoute.Builder
Overrides

build()

public TransitionRoute build()
Returns
Type Description
TransitionRoute

buildPartial()

public TransitionRoute buildPartial()
Returns
Type Description
TransitionRoute

clear()

public TransitionRoute.Builder clear()
Returns
Type Description
TransitionRoute.Builder
Overrides

clearCondition()

public TransitionRoute.Builder clearCondition()

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
TransitionRoute.Builder

This builder for chaining.

clearDescription()

public TransitionRoute.Builder clearDescription()

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

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

Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransitionRoute.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransitionRoute.Builder
Overrides

clearIntent()

public TransitionRoute.Builder clearIntent()

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
TransitionRoute.Builder

This builder for chaining.

clearName()

public TransitionRoute.Builder clearName()

Output only. The unique identifier of this transition route.

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

Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransitionRoute.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransitionRoute.Builder
Overrides

clearTarget()

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

clearTargetFlow()

public TransitionRoute.Builder clearTargetFlow()

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
TransitionRoute.Builder

This builder for chaining.

clearTargetPage()

public TransitionRoute.Builder clearTargetPage()

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
TransitionRoute.Builder

This builder for chaining.

clearTriggerFulfillment()

public TransitionRoute.Builder clearTriggerFulfillment()

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
TransitionRoute.Builder

clone()

public TransitionRoute.Builder clone()
Returns
Type Description
TransitionRoute.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
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.

getTargetCase()

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

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
Type Description
Fulfillment

The triggerFulfillment.

getTriggerFulfillmentBuilder()

public Fulfillment.Builder getTriggerFulfillmentBuilder()

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
Fulfillment.Builder

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
Type Description
FulfillmentOrBuilder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TransitionRoute other)

public TransitionRoute.Builder mergeFrom(TransitionRoute other)
Parameter
Name Description
other TransitionRoute
Returns
Type Description
TransitionRoute.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransitionRoute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransitionRoute.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransitionRoute.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransitionRoute.Builder
Overrides

mergeTriggerFulfillment(Fulfillment value)

public TransitionRoute.Builder mergeTriggerFulfillment(Fulfillment value)

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;

Parameter
Name Description
value Fulfillment
Returns
Type Description
TransitionRoute.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransitionRoute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransitionRoute.Builder
Overrides

setCondition(String value)

public TransitionRoute.Builder setCondition(String value)

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;

Parameter
Name Description
value String

The condition to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setConditionBytes(ByteString value)

public TransitionRoute.Builder setConditionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for condition to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setDescription(String value)

public TransitionRoute.Builder setDescription(String value)

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

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TransitionRoute.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransitionRoute.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransitionRoute.Builder
Overrides

setIntent(String value)

public TransitionRoute.Builder setIntent(String value)

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) = { ... }

Parameter
Name Description
value String

The intent to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setIntentBytes(ByteString value)

public TransitionRoute.Builder setIntentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for intent to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setName(String value)

public TransitionRoute.Builder setName(String value)

Output only. The unique identifier of this transition route.

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TransitionRoute.Builder setNameBytes(ByteString value)

Output only. The unique identifier of this transition route.

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransitionRoute.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransitionRoute.Builder
Overrides

setTargetFlow(String value)

public TransitionRoute.Builder setTargetFlow(String value)

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) = { ... }

Parameter
Name Description
value String

The targetFlow to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setTargetFlowBytes(ByteString value)

public TransitionRoute.Builder setTargetFlowBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for targetFlow to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setTargetPage(String value)

public TransitionRoute.Builder setTargetPage(String value)

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) = { ... }

Parameter
Name Description
value String

The targetPage to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setTargetPageBytes(ByteString value)

public TransitionRoute.Builder setTargetPageBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for targetPage to set.
Returns
Type Description
TransitionRoute.Builder

This builder for chaining.

setTriggerFulfillment(Fulfillment value)

public TransitionRoute.Builder setTriggerFulfillment(Fulfillment value)

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;

Parameter
Name Description
value Fulfillment
Returns
Type Description
TransitionRoute.Builder

setTriggerFulfillment(Fulfillment.Builder builderForValue)

public TransitionRoute.Builder setTriggerFulfillment(Fulfillment.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Fulfillment.Builder
Returns
Type Description
TransitionRoute.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TransitionRoute.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransitionRoute.Builder
Overrides