Package com.google.cloud.dialogflow.cx.v3beta1

Class TransitionRoute

  • All Implemented Interfaces:
    TransitionRouteOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TransitionRoute
extends com.google.protobuf.GeneratedMessageV3
implements TransitionRouteOrBuilder
     A transition route specifies a
 [intent][google.cloud.dialogflow.cx.v3beta1.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`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.trigger_fulfillment]
 associated with the transition, it will be called.
 *   If there is a
 [`target_page`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.target_page]
 associated with the transition, the session will transition into the
 specified page.
 *   If there is a
 [`target_flow`][google.cloud.dialogflow.cx.v3beta1.TransitionRoute.target_flow]
 associated with the transition, the session will transition into the
 specified flow.
    Protobuf type google.cloud.dialogflow.cx.v3beta1.TransitionRoute
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TransitionRoute.Builder
      A transition route specifies a [intent][google.cloud.dialogflow.cx.v3beta1.Intent] that can be matched and/or a data condition that can be evaluated during a session.
      static class  TransitionRoute.TargetCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The unique identifier of this transition route.
        string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface TransitionRouteOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The unique identifier of this transition route.
        string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for name.

      • 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];
        Specified by:
        getDescription in interface TransitionRouteOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. The description of the transition route. The maximum length is
 500 characters.
        string description = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for description.

      • getIntent

        public String getIntent()
         The unique identifier of an
 [Intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
        Specified by:
        getIntent in interface TransitionRouteOrBuilder
        Returns:
        The intent.

      • getIntentBytes

        public com.google.protobuf.ByteString getIntentBytes()
         The unique identifier of an
 [Intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
        Specified by:
        getIntentBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for intent.

      • getCondition

        public String getCondition()
         The condition to evaluate against [form
 parameters][google.cloud.dialogflow.cx.v3beta1.Form.parameters] or [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 See the [conditions
 reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
 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;
        Specified by:
        getCondition in interface TransitionRouteOrBuilder
        Returns:
        The condition.

      • getConditionBytes

        public com.google.protobuf.ByteString getConditionBytes()
         The condition to evaluate against [form
 parameters][google.cloud.dialogflow.cx.v3beta1.Form.parameters] or [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 See the [conditions
 reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
 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;
        Specified by:
        getConditionBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for condition.

      • 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;
        Specified by:
        hasTriggerFulfillment in interface TransitionRouteOrBuilder
        Returns:
        Whether the triggerFulfillment field is set.

      • 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;
        Specified by:
        getTriggerFulfillment in interface TransitionRouteOrBuilder
        Returns:
        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;
        Specified by:
        getTriggerFulfillmentOrBuilder in interface TransitionRouteOrBuilder

      • 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) = { ... }
        Specified by:
        hasTargetPage in interface TransitionRouteOrBuilder
        Returns:
        Whether the targetPage field is set.

      • 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) = { ... }
        Specified by:
        getTargetPage in interface TransitionRouteOrBuilder
        Returns:
        The targetPage.

      • getTargetPageBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetPageBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for targetPage.

      • 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) = { ... }
        Specified by:
        hasTargetFlow in interface TransitionRouteOrBuilder
        Returns:
        Whether the targetFlow field is set.

      • 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) = { ... }
        Specified by:
        getTargetFlow in interface TransitionRouteOrBuilder
        Returns:
        The targetFlow.

      • getTargetFlowBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getTargetFlowBytes in interface TransitionRouteOrBuilder
        Returns:
        The bytes for targetFlow.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static TransitionRoute parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static TransitionRoute parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public TransitionRoute.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public TransitionRoute.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected TransitionRoute.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<TransitionRoute> parser()

      • getParserForType

        public com.google.protobuf.Parser<TransitionRoute> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public TransitionRoute getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder