- 0.66.0 (latest)
- 0.65.0
- 0.64.0
- 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 static final class Page.Builder extends GeneratedMessageV3.Builder<Page.Builder> implements PageOrBuilderA 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.v3beta1.Page
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Page.BuilderImplements
PageOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEventHandlers(Iterable<? extends EventHandler> values)
public Page.Builder addAllEventHandlers(Iterable<? extends EventHandler> values)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.EventHandler> |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addAllTransitionRouteGroups(Iterable<String> values)
public Page.Builder addAllTransitionRouteGroups(Iterable<String> values) 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
addAllTransitionRoutes(Iterable<? extends TransitionRoute> values)
public Page.Builder addAllTransitionRoutes(Iterable<? extends TransitionRoute> values)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.TransitionRoute> |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addEventHandlers(EventHandler value)
public Page.Builder addEventHandlers(EventHandler value)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addEventHandlers(EventHandler.Builder builderForValue)
public Page.Builder addEventHandlers(EventHandler.Builder builderForValue)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addEventHandlers(int index, EventHandler value)
public Page.Builder addEventHandlers(int index, EventHandler value)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addEventHandlers(int index, EventHandler.Builder builderForValue)
public Page.Builder addEventHandlers(int index, EventHandler.Builder builderForValue)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addEventHandlersBuilder()
public EventHandler.Builder addEventHandlersBuilder()Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
EventHandler.Builder |
|
addEventHandlersBuilder(int index)
public EventHandler.Builder addEventHandlersBuilder(int index)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventHandler.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Page.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addTransitionRouteGroups(String value)
public Page.Builder addTransitionRouteGroups(String value) 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
addTransitionRouteGroupsBytes(ByteString value)
public Page.Builder addTransitionRouteGroupsBytes(ByteString value) 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
addTransitionRoutes(TransitionRoute value)
public Page.Builder addTransitionRoutes(TransitionRoute value)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addTransitionRoutes(TransitionRoute.Builder builderForValue)
public Page.Builder addTransitionRoutes(TransitionRoute.Builder builderForValue)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addTransitionRoutes(int index, TransitionRoute value)
public Page.Builder addTransitionRoutes(int index, TransitionRoute value)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addTransitionRoutes(int index, TransitionRoute.Builder builderForValue)
public Page.Builder addTransitionRoutes(int index, TransitionRoute.Builder builderForValue)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
addTransitionRoutesBuilder()
public TransitionRoute.Builder addTransitionRoutesBuilder()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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
addTransitionRoutesBuilder(int index)
public TransitionRoute.Builder addTransitionRoutesBuilder(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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
build()
public Page build()| Returns | |
|---|---|
| Type | Description |
Page |
|
buildPartial()
public Page buildPartial()| Returns | |
|---|---|
| Type | Description |
Page |
|
clear()
public Page.Builder clear()| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearAdvancedSettings()
public Page.Builder clearAdvancedSettings()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.v3beta1.AdvancedSettings advanced_settings = 13;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearDescription()
public Page.Builder clearDescription()The description of the page. The maximum length is 500 characters.
string description = 19;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
clearDisplayName()
public Page.Builder clearDisplayName()Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
clearEntryFulfillment()
public Page.Builder clearEntryFulfillment()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearEventHandlers()
public Page.Builder clearEventHandlers()Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Page.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearForm()
public Page.Builder clearForm()The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearKnowledgeConnectorSettings()
public Page.Builder clearKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearName()
public Page.Builder clearName() The unique identifier of the page.
Required for the
Pages.UpdatePage
method.
Pages.CreatePage
populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearTransitionRouteGroups()
public Page.Builder clearTransitionRouteGroups() 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
clearTransitionRoutes()
public Page.Builder clearTransitionRoutes()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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clone()
public Page.Builder clone()| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
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.v3beta1.AdvancedSettings advanced_settings = 13;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsBuilder()
public AdvancedSettings.Builder getAdvancedSettingsBuilder()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.v3beta1.AdvancedSettings advanced_settings = 13;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings.Builder |
|
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.v3beta1.AdvancedSettings advanced_settings = 13;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getDefaultInstanceForType()
public Page getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Page |
|
getDescription()
public String getDescription()The description of the page. The maximum length is 500 characters.
string description = 19;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()The description of the page. The maximum length is 500 characters.
string description = 19;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 | |
|---|---|
| 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];
| Returns | |
|---|---|
| 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.v3beta1.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
Fulfillment |
The entryFulfillment. |
getEntryFulfillmentBuilder()
public Fulfillment.Builder getEntryFulfillmentBuilder()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
getEntryFulfillmentOrBuilder()
public FulfillmentOrBuilder getEntryFulfillmentOrBuilder()The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventHandler |
|
getEventHandlersBuilder(int index)
public EventHandler.Builder getEventHandlersBuilder(int index)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EventHandler.Builder |
|
getEventHandlersBuilderList()
public List<EventHandler.Builder> getEventHandlersBuilderList()Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.EventHandlerOrBuilder> |
|
getForm()
public Form getForm()The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Returns | |
|---|---|
| Type | Description |
Form |
The form. |
getFormBuilder()
public Form.Builder getFormBuilder()The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Returns | |
|---|---|
| Type | Description |
Form.Builder |
|
getFormOrBuilder()
public FormOrBuilder getFormOrBuilder()The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Returns | |
|---|---|
| Type | Description |
FormOrBuilder |
|
getKnowledgeConnectorSettings()
public KnowledgeConnectorSettings getKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
KnowledgeConnectorSettings |
The knowledgeConnectorSettings. |
getKnowledgeConnectorSettingsBuilder()
public KnowledgeConnectorSettings.Builder getKnowledgeConnectorSettingsBuilder()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
KnowledgeConnectorSettings.Builder |
|
getKnowledgeConnectorSettingsOrBuilder()
public KnowledgeConnectorSettingsOrBuilder getKnowledgeConnectorSettingsOrBuilder()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
string name = 1;
| Returns | |
|---|---|
| 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>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 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>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 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute |
|
getTransitionRoutesBuilder(int index)
public TransitionRoute.Builder getTransitionRoutesBuilder(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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
getTransitionRoutesBuilderList()
public List<TransitionRoute.Builder> getTransitionRoutesBuilderList()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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.TransitionRoute transition_routes = 9;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.AdvancedSettings advanced_settings = 13;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.Fulfillment entry_fulfillment = 7;
| Returns | |
|---|---|
| Type | Description |
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.v3beta1.Form form = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the form field is set. |
hasKnowledgeConnectorSettings()
public boolean hasKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the knowledgeConnectorSettings field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdvancedSettings(AdvancedSettings value)
public Page.Builder mergeAdvancedSettings(AdvancedSettings value)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.v3beta1.AdvancedSettings advanced_settings = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeEntryFulfillment(Fulfillment value)
public Page.Builder mergeEntryFulfillment(Fulfillment value)The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
Fulfillment |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeForm(Form value)
public Page.Builder mergeForm(Form value)The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Form |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeFrom(Page other)
public Page.Builder mergeFrom(Page other)| Parameter | |
|---|---|
| Name | Description |
other |
Page |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Page.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeKnowledgeConnectorSettings(KnowledgeConnectorSettings value)
public Page.Builder mergeKnowledgeConnectorSettings(KnowledgeConnectorSettings value)Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
KnowledgeConnectorSettings |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Page.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
removeEventHandlers(int index)
public Page.Builder removeEventHandlers(int index)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
removeTransitionRoutes(int index)
public Page.Builder removeTransitionRoutes(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.v3beta1.TransitionRoute transition_routes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setAdvancedSettings(AdvancedSettings value)
public Page.Builder setAdvancedSettings(AdvancedSettings value)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.v3beta1.AdvancedSettings advanced_settings = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setAdvancedSettings(AdvancedSettings.Builder builderForValue)
public Page.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)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.v3beta1.AdvancedSettings advanced_settings = 13;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AdvancedSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setDescription(String value)
public Page.Builder setDescription(String value)The description of the page. The maximum length is 500 characters.
string description = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Page.Builder setDescriptionBytes(ByteString value)The description of the page. The maximum length is 500 characters.
string description = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setDisplayName(String value)
public Page.Builder setDisplayName(String value)Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Page.Builder setDisplayNameBytes(ByteString value)Required. The human-readable name of the page, unique within the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setEntryFulfillment(Fulfillment value)
public Page.Builder setEntryFulfillment(Fulfillment value)The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
Fulfillment |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setEntryFulfillment(Fulfillment.Builder builderForValue)
public Page.Builder setEntryFulfillment(Fulfillment.Builder builderForValue)The fulfillment to call when the session is entering the page.
.google.cloud.dialogflow.cx.v3beta1.Fulfillment entry_fulfillment = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Fulfillment.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setEventHandlers(int index, EventHandler value)
public Page.Builder setEventHandlers(int index, EventHandler value)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setEventHandlers(int index, EventHandler.Builder builderForValue)
public Page.Builder setEventHandlers(int index, EventHandler.Builder builderForValue)Handlers associated with the page to handle events such as webhook errors, no match or no input.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Page.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setForm(Form value)
public Page.Builder setForm(Form value)The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Form |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setForm(Form.Builder builderForValue)
public Page.Builder setForm(Form.Builder builderForValue)The form associated with the page, used for collecting parameters relevant to the page.
.google.cloud.dialogflow.cx.v3beta1.Form form = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Form.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setKnowledgeConnectorSettings(KnowledgeConnectorSettings value)
public Page.Builder setKnowledgeConnectorSettings(KnowledgeConnectorSettings value)Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
KnowledgeConnectorSettings |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setKnowledgeConnectorSettings(KnowledgeConnectorSettings.Builder builderForValue)
public Page.Builder setKnowledgeConnectorSettings(KnowledgeConnectorSettings.Builder builderForValue)Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
KnowledgeConnectorSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setName(String value)
public Page.Builder setName(String value) The unique identifier of the page.
Required for the
Pages.UpdatePage
method.
Pages.CreatePage
populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Page.Builder setNameBytes(ByteString value) The unique identifier of the page.
Required for the
Pages.UpdatePage
method.
Pages.CreatePage
populates the name automatically.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Page.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setTransitionRouteGroups(int index, String value)
public Page.Builder setTransitionRouteGroups(int index, String value) 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID>orprojects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID>for agent-level groups.
repeated string transition_route_groups = 11 [(.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe transitionRouteGroups to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
setTransitionRoutes(int index, TransitionRoute value)
public Page.Builder setTransitionRoutes(int index, TransitionRoute value)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setTransitionRoutes(int index, TransitionRoute.Builder builderForValue)
public Page.Builder setTransitionRoutes(int index, TransitionRoute.Builder builderForValue)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.v3beta1.TransitionRoute transition_routes = 9;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Page.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|