Class Page (0.52.0)

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

Implements

PageOrBuilder

Static Fields

ADVANCED_SETTINGS_FIELD_NUMBER

public static final int ADVANCED_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENTRY_FULFILLMENT_FIELD_NUMBER

public static final int ENTRY_FULFILLMENT_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_HANDLERS_FIELD_NUMBER

public static final int EVENT_HANDLERS_FIELD_NUMBER
Field Value
TypeDescription
int

FORM_FIELD_NUMBER

public static final int FORM_FIELD_NUMBER
Field Value
TypeDescription
int

KNOWLEDGE_CONNECTOR_SETTINGS_FIELD_NUMBER

public static final int KNOWLEDGE_CONNECTOR_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSITION_ROUTES_FIELD_NUMBER

public static final int TRANSITION_ROUTES_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSITION_ROUTE_GROUPS_FIELD_NUMBER

public static final int TRANSITION_ROUTE_GROUPS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Page getDefaultInstance()
Returns
TypeDescription
Page

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Page.Builder newBuilder()
Returns
TypeDescription
Page.Builder

newBuilder(Page prototype)

public static Page.Builder newBuilder(Page prototype)
Parameter
NameDescription
prototypePage
Returns
TypeDescription
Page.Builder

parseDelimitedFrom(InputStream input)

public static Page parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Page parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Page parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Page parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Page parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Page parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Page> parser()
Returns
TypeDescription
Parser<Page>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdvancedSettings()

public 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
TypeDescription
AdvancedSettings

The advancedSettings.

getAdvancedSettingsOrBuilder()

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

Returns
TypeDescription
AdvancedSettingsOrBuilder

getDefaultInstanceForType()

public Page getDefaultInstanceForType()
Returns
TypeDescription
Page

getDescription()

public String getDescription()

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

string description = 19;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 19;

Returns
TypeDescription
ByteString

The bytes for description.

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

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

Returns
TypeDescription
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;

Returns
TypeDescription
Fulfillment

The entryFulfillment.

getEntryFulfillmentOrBuilder()

public FulfillmentOrBuilder getEntryFulfillmentOrBuilder()

The fulfillment to call when the session is entering the page.

.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;

Returns
TypeDescription
FulfillmentOrBuilder

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
EventHandler

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<EventHandler>

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
EventHandlerOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.cx.v3.EventHandlerOrBuilder>

getForm()

public 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
TypeDescription
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;

Returns
TypeDescription
FormOrBuilder

getKnowledgeConnectorSettings()

public KnowledgeConnectorSettings getKnowledgeConnectorSettings()

Optional. Knowledge connector configuration.

.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
KnowledgeConnectorSettings

The knowledgeConnectorSettings.

getKnowledgeConnectorSettingsOrBuilder()

public KnowledgeConnectorSettingsOrBuilder getKnowledgeConnectorSettingsOrBuilder()

Optional. Knowledge connector configuration.

.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
KnowledgeConnectorSettingsOrBuilder

getName()

public String 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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Page> getParserForType()
Returns
TypeDescription
Parser<Page>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTransitionRouteGroups(int index)

public String getTransitionRouteGroups(int index)

Ordered list of TransitionRouteGroups 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) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The transitionRouteGroups at the given index.

getTransitionRouteGroupsBytes(int index)

public ByteString getTransitionRouteGroupsBytes(int index)

Ordered list of TransitionRouteGroups 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) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the transitionRouteGroups at the given index.

getTransitionRouteGroupsCount()

public int getTransitionRouteGroupsCount()

Ordered list of TransitionRouteGroups 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
TypeDescription
int

The count of transitionRouteGroups.

getTransitionRouteGroupsList()

public ProtocolStringList getTransitionRouteGroupsList()

Ordered list of TransitionRouteGroups 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
TypeDescription
ProtocolStringList

A list containing the transitionRouteGroups.

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TransitionRoute

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<TransitionRoute>

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
TransitionRouteOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.cloud.dialogflow.cx.v3.TransitionRouteOrBuilder>

hasAdvancedSettings()

public 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
TypeDescription
boolean

Whether the advancedSettings field is set.

hasEntryFulfillment()

public boolean hasEntryFulfillment()

The fulfillment to call when the session is entering the page.

.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;

Returns
TypeDescription
boolean

Whether the entryFulfillment field is set.

hasForm()

public 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
TypeDescription
boolean

Whether the form field is set.

hasKnowledgeConnectorSettings()

public boolean hasKnowledgeConnectorSettings()

Optional. Knowledge connector configuration.

.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the knowledgeConnectorSettings field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Page.Builder newBuilderForType()
Returns
TypeDescription
Page.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Page.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Page.Builder toBuilder()
Returns
TypeDescription
Page.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException