- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
public interface PageOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdvancedSettings()
public abstract 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 | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getDescription()
public abstract String getDescription()The description of the page. The maximum length is 500 characters.
string description = 19;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()The description of the page. The maximum length is 500 characters.
string description = 19;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDisplayName()
public abstract String getDisplayName()Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEntryFulfillment()
public abstract Fulfillment getEntryFulfillment()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
Fulfillment |
The entryFulfillment. |
getEntryFulfillmentOrBuilder()
public abstract FulfillmentOrBuilder getEntryFulfillmentOrBuilder()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
FulfillmentOrBuilder |
|
getEventHandlers(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventHandler |
|
getEventHandlersCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
|
getEventHandlersList()
public abstract 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 | |
|---|---|
| Type | Description |
List<EventHandler> |
|
getEventHandlersOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventHandlerOrBuilder |
|
getEventHandlersOrBuilderList()
public abstract 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 | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3.EventHandlerOrBuilder> |
|
getForm()
public abstract 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 | |
|---|---|
| Type | Description |
Form |
The form. |
getFormOrBuilder()
public abstract 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 | |
|---|---|
| Type | Description |
FormOrBuilder |
|
getKnowledgeConnectorSettings()
public abstract KnowledgeConnectorSettings getKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
KnowledgeConnectorSettings |
The knowledgeConnectorSettings. |
getKnowledgeConnectorSettingsOrBuilder()
public abstract KnowledgeConnectorSettingsOrBuilder getKnowledgeConnectorSettingsOrBuilder()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
KnowledgeConnectorSettingsOrBuilder |
|
getName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getTransitionRouteGroups(int index)
public abstract 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>orprojects/<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 | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The transitionRouteGroups at the given index. |
getTransitionRouteGroupsBytes(int index)
public abstract 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>orprojects/<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 | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the transitionRouteGroups at the given index. |
getTransitionRouteGroupsCount()
public abstract 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>orprojects/<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 | |
|---|---|
| Type | Description |
int |
The count of transitionRouteGroups. |
getTransitionRouteGroupsList()
public abstract List<String> 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>orprojects/<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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the transitionRouteGroups. |
getTransitionRoutes(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute |
|
getTransitionRoutesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
|
getTransitionRoutesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<TransitionRoute> |
|
getTransitionRoutesOrBuilder(int index)
public abstract 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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRouteOrBuilder |
|
getTransitionRoutesOrBuilderList()
public abstract 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 | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3.TransitionRouteOrBuilder> |
|
hasAdvancedSettings()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSettings field is set. |
hasEntryFulfillment()
public abstract boolean hasEntryFulfillment()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the entryFulfillment field is set. |
hasForm()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the form field is set. |
hasKnowledgeConnectorSettings()
public abstract boolean hasKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the knowledgeConnectorSettings field is set. |