Package com.google.cloud.dialogflow.cx.v3

Interface PageOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Page, Page.Builder
    public interface PageOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         The unique identifier of the page.
 Required for the
 [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method.
 [Pages.CreatePage][google.cloud.dialogflow.cx.v3.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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The unique identifier of the page.
 Required for the
 [Pages.UpdatePage][google.cloud.dialogflow.cx.v3.Pages.UpdatePage] method.
 [Pages.CreatePage][google.cloud.dialogflow.cx.v3.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;
        Returns:
        The bytes for name.

      • getDisplayName

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

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • hasEntryFulfillment

        boolean hasEntryFulfillment()
         The fulfillment to call when the session is entering the page.
        .google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
        Returns:
        Whether the entryFulfillment field is set.

      • getEntryFulfillment

        Fulfillment getEntryFulfillment()
         The fulfillment to call when the session is entering the page.
        .google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
        Returns:
        The entryFulfillment.

      • getEntryFulfillmentOrBuilder

        FulfillmentOrBuilder getEntryFulfillmentOrBuilder()
         The fulfillment to call when the session is entering the page.
        .google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;

      • hasForm

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

      • getForm

        Form getForm()
         The form associated with the page, used for collecting parameters
 relevant to the page.
        .google.cloud.dialogflow.cx.v3.Form form = 4;
        Returns:
        The form.

      • getFormOrBuilder

        FormOrBuilder getFormOrBuilder()
         The form associated with the page, used for collecting parameters
 relevant to the page.
        .google.cloud.dialogflow.cx.v3.Form form = 4;

      • getTransitionRouteGroupsList

        List<String> getTransitionRouteGroupsList()
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.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) = { ... }
        Returns:
        A list containing the transitionRouteGroups.

      • getTransitionRouteGroupsCount

        int getTransitionRouteGroupsCount()
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.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) = { ... }
        Returns:
        The count of transitionRouteGroups.

      • getTransitionRouteGroups

        String getTransitionRouteGroups​(int index)
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The transitionRouteGroups at the given index.

      • getTransitionRouteGroupsBytes

        com.google.protobuf.ByteString getTransitionRouteGroupsBytes​(int index)
         Ordered list of
 [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the transitionRouteGroups at the given index.

      • getTransitionRoutesList

        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.v3.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.v3.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.v3.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;

      • getTransitionRoutes

        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.v3.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.v3.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.v3.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;

      • getTransitionRoutesCount

        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.v3.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.v3.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.v3.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;

      • getTransitionRoutesOrBuilderList

        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.v3.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.v3.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.v3.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;

      • getTransitionRoutesOrBuilder

        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.v3.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.v3.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.v3.Page.transition_route_groups]
     with only condition specified.
        repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;

      • getEventHandlersList

        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.v3.EventHandler event_handlers = 10;

      • getEventHandlers

        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.v3.EventHandler event_handlers = 10;

      • getEventHandlersCount

        int getEventHandlersCount()
         Handlers associated with the page to handle events such as webhook errors,
 no match or no input.
        repeated .google.cloud.dialogflow.cx.v3.EventHandler event_handlers = 10;

      • getEventHandlersOrBuilderList

        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.v3.EventHandler event_handlers = 10;

      • getEventHandlersOrBuilder

        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.v3.EventHandler event_handlers = 10;

      • hasKnowledgeConnectorSettings

        boolean hasKnowledgeConnectorSettings()
         Optional. Knowledge connector configuration.
        .google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the knowledgeConnectorSettings field is set.

      • getKnowledgeConnectorSettings

        KnowledgeConnectorSettings getKnowledgeConnectorSettings()
         Optional. Knowledge connector configuration.
        .google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The knowledgeConnectorSettings.

      • getKnowledgeConnectorSettingsOrBuilder

        KnowledgeConnectorSettingsOrBuilder getKnowledgeConnectorSettingsOrBuilder()
         Optional. Knowledge connector configuration.
        .google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];