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 Summary

Modifier and Type	Method and Description
AdvancedSettings	getAdvancedSettings() Hierarchical advanced settings for this page.
AdvancedSettingsOrBuilder	getAdvancedSettingsOrBuilder() Hierarchical advanced settings for this page.
String	getDescription() The description of the page.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the page.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Fulfillment	getEntryFulfillment() The fulfillment to call when the session is entering the page.
FulfillmentOrBuilder	getEntryFulfillmentOrBuilder() The fulfillment to call when the session is entering the page.
EventHandler	getEventHandlers(int index) Handlers associated with the page to handle events such as webhook errors, no match or no input.
int	getEventHandlersCount() Handlers associated with the page to handle events such as webhook errors, no match or no input.
List<EventHandler>	getEventHandlersList() Handlers associated with the page to handle events such as webhook errors, no match or no input.
EventHandlerOrBuilder	getEventHandlersOrBuilder(int index) Handlers associated with the page to handle events such as webhook errors, no match or no input.
List<? extends EventHandlerOrBuilder>	getEventHandlersOrBuilderList() Handlers associated with the page to handle events such as webhook errors, no match or no input.
Form	getForm() The form associated with the page, used for collecting parameters relevant to the page.
FormOrBuilder	getFormOrBuilder() The form associated with the page, used for collecting parameters relevant to the page.
KnowledgeConnectorSettings	getKnowledgeConnectorSettings() Optional.
KnowledgeConnectorSettingsOrBuilder	getKnowledgeConnectorSettingsOrBuilder() Optional.
String	getName() The unique identifier of the page.
com.google.protobuf.ByteString	getNameBytes() The unique identifier of the page.
String	getTransitionRouteGroups(int index) Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] added to the page.
com.google.protobuf.ByteString	getTransitionRouteGroupsBytes(int index) Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] added to the page.
int	getTransitionRouteGroupsCount() Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] added to the page.
List<String>	getTransitionRouteGroupsList() Ordered list of [`TransitionRouteGroups`][google.cloud.dialogflow.cx.v3.TransitionRouteGroup] added to the page.
TransitionRoute	getTransitionRoutes(int index) A list of transitions for the transition rules of this page.
int	getTransitionRoutesCount() A list of transitions for the transition rules of this page.
List<TransitionRoute>	getTransitionRoutesList() A list of transitions for the transition rules of this page.
TransitionRouteOrBuilder	getTransitionRoutesOrBuilder(int index) A list of transitions for the transition rules of this page.
List<? extends TransitionRouteOrBuilder>	getTransitionRoutesOrBuilderList() A list of transitions for the transition rules of this page.
boolean	hasAdvancedSettings() Hierarchical advanced settings for this page.
boolean	hasEntryFulfillment() The fulfillment to call when the session is entering the page.
boolean	hasForm() The form associated with the page, used for collecting parameters relevant to the page.
boolean	hasKnowledgeConnectorSettings() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
 

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
 

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.

getDescription

String getDescription()

 The description of the page. The maximum length is 500 characters.
 

string description = 19;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the page. The maximum length is 500 characters.
 

string description = 19;

Returns:

The bytes for description.

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>`
 or
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>`
 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 evaluated 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 evaluated 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 evaluated 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 evaluated 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 evaluated 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;

hasAdvancedSettings

boolean hasAdvancedSettings()

 Hierarchical advanced settings for this page. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
 

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 13;

Returns:

Whether the advancedSettings field is set.

getAdvancedSettings

AdvancedSettings getAdvancedSettings()

 Hierarchical advanced settings for this page. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
 

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 13;

Returns:

The advancedSettings.

getAdvancedSettingsOrBuilder

AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()

 Hierarchical advanced settings for this page. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
 

.google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 13;

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];