public final class Page extends 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.
Protobuf type google.cloud.dialogflow.cx.v3.Page
Static Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ENTRY_FULFILLMENT_FIELD_NUMBER
public static final int ENTRY_FULFILLMENT_FIELD_NUMBER
Field Value
EVENT_HANDLERS_FIELD_NUMBER
public static final int EVENT_HANDLERS_FIELD_NUMBER
Field Value
FORM_FIELD_NUMBER
public static final int FORM_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
TRANSITION_ROUTES_FIELD_NUMBER
public static final int TRANSITION_ROUTES_FIELD_NUMBER
Field Value
TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
public static final int TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Page getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Page.Builder newBuilder()
Returns
newBuilder(Page prototype)
public static Page.Builder newBuilder(Page prototype)
Parameter
| Name |
Description |
prototype |
Page
|
Returns
parseDelimitedFrom(InputStream input)
public static Page parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Page parseFrom(byte[] data)
Parameter
| Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Page parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static Page parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static Page parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Page parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Page> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Page getDefaultInstanceForType()
Returns
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];
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type |
Description |
ByteString |
The bytes for displayName.
|
getEntryFulfillment()
public Fulfillment getEntryFulfillment()
The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
getEntryFulfillmentOrBuilder()
public FulfillmentOrBuilder getEntryFulfillmentOrBuilder()
The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
getEventHandlers(int index)
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.v3.EventHandler event_handlers = 10;
| Name |
Description |
index |
int
|
Returns
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.v3.EventHandler event_handlers = 10;
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.v3.EventHandler event_handlers = 10;
getEventHandlersOrBuilder(int index)
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.v3.EventHandler event_handlers = 10;
| Name |
Description |
index |
int
|
Returns
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.v3.EventHandler event_handlers = 10;
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.EventHandlerOrBuilder> |
|
getForm()
The form associated with the page, used for collecting parameters
relevant to the page.
.google.cloud.dialogflow.cx.v3.Form form = 4;
| Type |
Description |
Form |
The form.
|
getFormOrBuilder()
public FormOrBuilder getFormOrBuilder()
The form associated with the page, used for collecting parameters
relevant to the page.
.google.cloud.dialogflow.cx.v3.Form form = 4;
getName()
The unique identifier of the page.
Required for the
Pages.UpdatePage method.
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;
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
The unique identifier of the page.
Required for the
Pages.UpdatePage method.
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;
getParserForType()
public Parser<Page> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTransitionRouteGroups(int index)
public String getTransitionRouteGroups(int index)
Ordered list of
TransitionRouteGroups
associated with the page. Transition route groups must be unique within a
page.
- 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>.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Name |
Description |
index |
int
The index of the element to return.
|
Returns
| Type |
Description |
String |
The transitionRouteGroups at the given index.
|
getTransitionRouteGroupsBytes(int index)
public ByteString getTransitionRouteGroupsBytes(int index)
Ordered list of
TransitionRouteGroups
associated with the page. Transition route groups must be unique within a
page.
- 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>.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Name |
Description |
index |
int
The index of the value to return.
|
Returns
| Type |
Description |
ByteString |
The bytes of the transitionRouteGroups at the given index.
|
getTransitionRouteGroupsCount()
public int getTransitionRouteGroupsCount()
Ordered list of
TransitionRouteGroups
associated with the page. Transition route groups must be unique within a
page.
- 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>.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Type |
Description |
int |
The count of transitionRouteGroups.
|
getTransitionRouteGroupsList()
public ProtocolStringList getTransitionRouteGroupsList()
Ordered list of
TransitionRouteGroups
associated with the page. Transition route groups must be unique within a
page.
- 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>.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
getTransitionRoutes(int index)
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
with intent specified.
- TransitionRoutes defined in flow with intent specified.
- TransitionRoutes defined in the
transition route
groups
with intent specified.
- TransitionRoutes defined in the page with only condition specified.
- TransitionRoutes defined in the
transition route
groups
with only condition specified.
repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;
| Name |
Description |
index |
int
|
Returns
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
with intent specified.
- TransitionRoutes defined in flow with intent specified.
- TransitionRoutes defined in the
transition route
groups
with intent specified.
- TransitionRoutes defined in the page with only condition specified.
- TransitionRoutes defined in the
transition route
groups
with only condition specified.
repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;
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
with intent specified.
- TransitionRoutes defined in flow with intent specified.
- TransitionRoutes defined in the
transition route
groups
with intent specified.
- TransitionRoutes defined in the page with only condition specified.
- TransitionRoutes defined in the
transition route
groups
with only condition specified.
repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;
getTransitionRoutesOrBuilder(int index)
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
with intent specified.
- TransitionRoutes defined in flow with intent specified.
- TransitionRoutes defined in the
transition route
groups
with intent specified.
- TransitionRoutes defined in the page with only condition specified.
- TransitionRoutes defined in the
transition route
groups
with only condition specified.
repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;
| Name |
Description |
index |
int
|
Returns
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
with intent specified.
- TransitionRoutes defined in flow with intent specified.
- TransitionRoutes defined in the
transition route
groups
with intent specified.
- TransitionRoutes defined in the page with only condition specified.
- TransitionRoutes defined in the
transition route
groups
with only condition specified.
repeated .google.cloud.dialogflow.cx.v3.TransitionRoute transition_routes = 9;
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.TransitionRouteOrBuilder> |
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasEntryFulfillment()
public boolean hasEntryFulfillment()
The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
| Type |
Description |
boolean |
Whether the entryFulfillment field is set.
|
hasForm()
The form associated with the page, used for collecting parameters
relevant to the page.
.google.cloud.dialogflow.cx.v3.Form form = 4;
| Type |
Description |
boolean |
Whether the form field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Page.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Page.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
