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

Class Page

  • All Implemented Interfaces:
    PageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Page
extends com.google.protobuf.GeneratedMessageV3
implements PageOrBuilder
     A Dialogflow CX conversation (session) can be described and visualized as a
 state machine. The states of a CX session are represented by pages.

 For each flow, you define many pages, where your combined pages can handle a
 complete conversation on the topics the flow is designed for. At any given
 moment, exactly one page is the current page, the current page is considered
 active, and the flow associated with that page is considered active. Every
 flow has a special start page. When a flow initially becomes active, the
 start page page becomes the current page. For each conversational turn, the
 current page will either stay the same or transition to another page.

 You configure each page to collect information from the end-user that is
 relevant for the conversational state represented by the page.

 For more information, see the
 [Page guide](https://cloud.google.com/dialogflow/cx/docs/concept/page).
    Protobuf type google.cloud.dialogflow.cx.v3beta1.Page
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTRY_FULFILLMENT_FIELD_NUMBER

        public static final int ENTRY_FULFILLMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSITION_ROUTE_GROUPS_FIELD_NUMBER

        public static final int TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSITION_ROUTES_FIELD_NUMBER

        public static final int TRANSITION_ROUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVENT_HANDLERS_FIELD_NUMBER

        public static final int EVENT_HANDLERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KNOWLEDGE_CONNECTOR_SETTINGS_FIELD_NUMBER

        public static final int KNOWLEDGE_CONNECTOR_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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()
         The unique identifier of the page.
 Required for the
 [Pages.UpdatePage][google.cloud.dialogflow.cx.v3beta1.Pages.UpdatePage]
 method.
 [Pages.CreatePage][google.cloud.dialogflow.cx.v3beta1.Pages.CreatePage]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.
        string name = 1;
        Specified by:
        getName in interface PageOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique identifier of the page.
 Required for the
 [Pages.UpdatePage][google.cloud.dialogflow.cx.v3beta1.Pages.UpdatePage]
 method.
 [Pages.CreatePage][google.cloud.dialogflow.cx.v3beta1.Pages.CreatePage]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/pages/<Page ID>`.
        string name = 1;
        Specified by:
        getNameBytes in interface PageOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The human-readable name of the page, unique within the flow.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface PageOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The human-readable name of the page, unique within the flow.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface PageOrBuilder
        Returns:
        The bytes for displayName.

      • hasEntryFulfillment

        public boolean hasEntryFulfillment()
         The fulfillment to call when the session is entering the page.
        .google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
        Specified by:
        hasEntryFulfillment in interface PageOrBuilder
        Returns:
        Whether the entryFulfillment field is set.

      • getEntryFulfillment

        public Fulfillment getEntryFulfillment()
         The fulfillment to call when the session is entering the page.
        .google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
        Specified by:
        getEntryFulfillment in interface PageOrBuilder
        Returns:
        The entryFulfillment.

      • hasForm

        public boolean hasForm()
         The form associated with the page, used for collecting parameters
 relevant to the page.
        .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
        Specified by:
        hasForm in interface PageOrBuilder
        Returns:
        Whether the form field is set.

      • getForm

        public Form getForm()
         The form associated with the page, used for collecting parameters
 relevant to the page.
        .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
        Specified by:
        getForm in interface PageOrBuilder
        Returns:
        The form.

      • getFormOrBuilder

        public FormOrBuilder getFormOrBuilder()
         The form associated with the page, used for collecting parameters
 relevant to the page.
        .google.cloud.dialogflow.cx.v3beta1.Form form = 4;
        Specified by:
        getFormOrBuilder in interface PageOrBuilder

      • getTransitionRouteGroupsList

        public com.google.protobuf.ProtocolStringList getTransitionRouteGroupsList()
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
 added to the page. Transition route groups must be unique within a page. If
 the page links both flow-level transition route groups and agent-level
 transition route groups, the flow-level ones will have higher priority and
 will be put before the agent-level ones.

 *   If multiple transition routes within a page scope refer to the same
     intent, then the precedence order is: page's transition route -> page's
     transition route group -> flow's transition routes.

 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.

 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
 or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
 groups.
        repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTransitionRouteGroupsList in interface PageOrBuilder
        Returns:
        A list containing the transitionRouteGroups.

      • getTransitionRouteGroupsCount

        public int getTransitionRouteGroupsCount()
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
 added to the page. Transition route groups must be unique within a page. If
 the page links both flow-level transition route groups and agent-level
 transition route groups, the flow-level ones will have higher priority and
 will be put before the agent-level ones.

 *   If multiple transition routes within a page scope refer to the same
     intent, then the precedence order is: page's transition route -> page's
     transition route group -> flow's transition routes.

 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.

 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
 or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
 groups.
        repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTransitionRouteGroupsCount in interface PageOrBuilder
        Returns:
        The count of transitionRouteGroups.

      • getTransitionRouteGroups

        public String getTransitionRouteGroups​(int index)
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
 added to the page. Transition route groups must be unique within a page. If
 the page links both flow-level transition route groups and agent-level
 transition route groups, the flow-level ones will have higher priority and
 will be put before the agent-level ones.

 *   If multiple transition routes within a page scope refer to the same
     intent, then the precedence order is: page's transition route -> page's
     transition route group -> flow's transition routes.

 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.

 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
 or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
 groups.
        repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTransitionRouteGroups in interface PageOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The transitionRouteGroups at the given index.

      • getTransitionRouteGroupsBytes

        public com.google.protobuf.ByteString getTransitionRouteGroupsBytes​(int index)
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3beta1.TransitionRouteGroup]
 added to the page. Transition route groups must be unique within a page. If
 the page links both flow-level transition route groups and agent-level
 transition route groups, the flow-level ones will have higher priority and
 will be put before the agent-level ones.

 *   If multiple transition routes within a page scope refer to the same
     intent, then the precedence order is: page's transition route -> page's
     transition route group -> flow's transition routes.

 *   If multiple transition route groups within a page contain the same
     intent, then the first group in the ordered list takes precedence.

 Format:`projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/flows/<Flow ID>/transitionRouteGroups/<TransitionRouteGroup ID>`
 or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/transitionRouteGroups/<TransitionRouteGroup ID>` for agent-level
 groups.
        repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTransitionRouteGroupsBytes in interface PageOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the transitionRouteGroups at the given index.

      • getTransitionRoutesList

        public List<TransitionRoute> getTransitionRoutesList()
         A list of transitions for the transition rules of this page.
 They route the conversation to another page in the same flow, or another
 flow.

 When we are in a certain page, the TransitionRoutes are evalauted in the
 following order:

 *   TransitionRoutes defined in the page with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in flow with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in the page with only condition specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
        Specified by:
        getTransitionRoutesList in interface PageOrBuilder

      • getTransitionRoutesOrBuilderList

        public List<? extends TransitionRouteOrBuilder> getTransitionRoutesOrBuilderList()
         A list of transitions for the transition rules of this page.
 They route the conversation to another page in the same flow, or another
 flow.

 When we are in a certain page, the TransitionRoutes are evalauted in the
 following order:

 *   TransitionRoutes defined in the page with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in flow with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in the page with only condition specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
        Specified by:
        getTransitionRoutesOrBuilderList in interface PageOrBuilder

      • getTransitionRoutesCount

        public int getTransitionRoutesCount()
         A list of transitions for the transition rules of this page.
 They route the conversation to another page in the same flow, or another
 flow.

 When we are in a certain page, the TransitionRoutes are evalauted in the
 following order:

 *   TransitionRoutes defined in the page with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in flow with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in the page with only condition specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
        Specified by:
        getTransitionRoutesCount in interface PageOrBuilder

      • getTransitionRoutes

        public TransitionRoute getTransitionRoutes​(int index)
         A list of transitions for the transition rules of this page.
 They route the conversation to another page in the same flow, or another
 flow.

 When we are in a certain page, the TransitionRoutes are evalauted in the
 following order:

 *   TransitionRoutes defined in the page with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in flow with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in the page with only condition specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
        Specified by:
        getTransitionRoutes in interface PageOrBuilder

      • getTransitionRoutesOrBuilder

        public TransitionRouteOrBuilder getTransitionRoutesOrBuilder​(int index)
         A list of transitions for the transition rules of this page.
 They route the conversation to another page in the same flow, or another
 flow.

 When we are in a certain page, the TransitionRoutes are evalauted in the
 following order:

 *   TransitionRoutes defined in the page with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in flow with intent specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Flow.transition_route_groups]
     with intent specified.
 *   TransitionRoutes defined in the page with only condition specified.
 *   TransitionRoutes defined in the
     [transition route
     groups][google.cloud.dialogflow.cx.v3beta1.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 9;
        Specified by:
        getTransitionRoutesOrBuilder in interface PageOrBuilder

      • getEventHandlersList

        public List<EventHandler> getEventHandlersList()
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
        Specified by:
        getEventHandlersList in interface PageOrBuilder

      • getEventHandlersOrBuilderList

        public List<? extends EventHandlerOrBuilder> getEventHandlersOrBuilderList()
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
        Specified by:
        getEventHandlersOrBuilderList in interface PageOrBuilder

      • getEventHandlersCount

        public int getEventHandlersCount()
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
        Specified by:
        getEventHandlersCount in interface PageOrBuilder

      • getEventHandlers

        public EventHandler getEventHandlers​(int index)
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
        Specified by:
        getEventHandlers in interface PageOrBuilder

      • getEventHandlersOrBuilder

        public EventHandlerOrBuilder getEventHandlersOrBuilder​(int index)
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
        Specified by:
        getEventHandlersOrBuilder in interface PageOrBuilder

      • hasKnowledgeConnectorSettings

        public boolean hasKnowledgeConnectorSettings()
         Optional. Knowledge connector configuration.
        .google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasKnowledgeConnectorSettings in interface PageOrBuilder
        Returns:
        Whether the knowledgeConnectorSettings field is set.

      • getKnowledgeConnectorSettings

        public KnowledgeConnectorSettings getKnowledgeConnectorSettings()
         Optional. Knowledge connector configuration.
        .google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getKnowledgeConnectorSettings in interface PageOrBuilder
        Returns:
        The knowledgeConnectorSettings.

      • 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 Page parseFrom​(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Page getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Page> 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 Page getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder