- 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 Flow.Builder extends GeneratedMessageV3.Builder<Flow.Builder> implements FlowOrBuilderFlows represents the conversation flows when you build your chatbot agent.
A flow consists of many pages connected by the transition routes. Conversations always start with the built-in Start Flow (with an all-0 ID). Transition routes can direct the conversation session from the current flow (parent flow) to another flow (sub flow). When the sub flow is finished, Dialogflow will bring the session back to the parent flow, where the sub flow is started.
Usually, when a transition route is followed by a matched intent, the intent will be "consumed". This means the intent won't activate more transition routes. However, when the followed transition route moves the conversation session into a different flow, the matched intent can be carried over and to be consumed in the target flow.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Flow
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Flow.BuilderImplements
FlowOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllEventHandlers(Iterable<? extends EventHandler> values)
public Flow.Builder addAllEventHandlers(Iterable<? extends EventHandler> values)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
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 |
Flow.Builder |
|
addAllTransitionRouteGroups(Iterable<String> values)
public Flow.Builder addAllTransitionRouteGroups(Iterable<String> values)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
addAllTransitionRoutes(Iterable<? extends TransitionRoute> values)
public Flow.Builder addAllTransitionRoutes(Iterable<? extends TransitionRoute> values)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.TransitionRoute> |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addEventHandlers(EventHandler value)
public Flow.Builder addEventHandlers(EventHandler value)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addEventHandlers(EventHandler.Builder builderForValue)
public Flow.Builder addEventHandlers(EventHandler.Builder builderForValue)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addEventHandlers(int index, EventHandler value)
public Flow.Builder addEventHandlers(int index, EventHandler value)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addEventHandlers(int index, EventHandler.Builder builderForValue)
public Flow.Builder addEventHandlers(int index, EventHandler.Builder builderForValue)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addEventHandlersBuilder()
public EventHandler.Builder addEventHandlersBuilder()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
EventHandler.Builder |
|
addEventHandlersBuilder(int index)
public EventHandler.Builder addEventHandlersBuilder(int index)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
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 Flow.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addTransitionRouteGroups(String value)
public Flow.Builder addTransitionRouteGroups(String value)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
addTransitionRouteGroupsBytes(ByteString value)
public Flow.Builder addTransitionRouteGroupsBytes(ByteString value)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the transitionRouteGroups to add. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
addTransitionRoutes(TransitionRoute value)
public Flow.Builder addTransitionRoutes(TransitionRoute value)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addTransitionRoutes(TransitionRoute.Builder builderForValue)
public Flow.Builder addTransitionRoutes(TransitionRoute.Builder builderForValue)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addTransitionRoutes(int index, TransitionRoute value)
public Flow.Builder addTransitionRoutes(int index, TransitionRoute value)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addTransitionRoutes(int index, TransitionRoute.Builder builderForValue)
public Flow.Builder addTransitionRoutes(int index, TransitionRoute.Builder builderForValue)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
addTransitionRoutesBuilder()
public TransitionRoute.Builder addTransitionRoutesBuilder()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
addTransitionRoutesBuilder(int index)
public TransitionRoute.Builder addTransitionRoutesBuilder(int index)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
build()
public Flow build()| Returns | |
|---|---|
| Type | Description |
Flow |
|
buildPartial()
public Flow buildPartial()| Returns | |
|---|---|
| Type | Description |
Flow |
|
clear()
public Flow.Builder clear()| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearAdvancedSettings()
public Flow.Builder clearAdvancedSettings()Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearDescription()
public Flow.Builder clearDescription()The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
clearDisplayName()
public Flow.Builder clearDisplayName()Required. The human-readable name of the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
clearEventHandlers()
public Flow.Builder clearEventHandlers()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Flow.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearKnowledgeConnectorSettings()
public Flow.Builder clearKnowledgeConnectorSettings()Optional. Knowledge connector configuration.
.google.cloud.dialogflow.cx.v3beta1.KnowledgeConnectorSettings knowledge_connector_settings = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearLocked()
public Flow.Builder clearLocked()Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.
bool locked = 30;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
clearMultiLanguageSettings()
public Flow.Builder clearMultiLanguageSettings()Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearName()
public Flow.Builder clearName() The unique identifier of the flow.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
clearNluSettings()
public Flow.Builder clearNluSettings()NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Flow.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clearTransitionRouteGroups()
public Flow.Builder clearTransitionRouteGroups()A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
clearTransitionRoutes()
public Flow.Builder clearTransitionRoutes()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
clone()
public Flow.Builder clone()| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
getAdvancedSettings()
public AdvancedSettings getAdvancedSettings()Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsBuilder()
public AdvancedSettings.Builder getAdvancedSettingsBuilder()Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings.Builder |
|
getAdvancedSettingsOrBuilder()
public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getDefaultInstanceForType()
public Flow getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Flow |
|
getDescription()
public String getDescription()The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;
| 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 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 flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getEventHandlers(int index)
public EventHandler getEventHandlers(int index)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
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)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
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()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getEventHandlersCount()
public int getEventHandlersCount()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEventHandlersList()
public List<EventHandler> getEventHandlersList()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
List<EventHandler> |
|
getEventHandlersOrBuilder(int index)
public EventHandlerOrBuilder getEventHandlersOrBuilder(int index)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
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()A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.EventHandlerOrBuilder> |
|
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 |
|
getLocked()
public boolean getLocked()Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.
bool locked = 30;
| Returns | |
|---|---|
| Type | Description |
boolean |
The locked. |
getMultiLanguageSettings()
public Flow.MultiLanguageSettings getMultiLanguageSettings()Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Flow.MultiLanguageSettings |
The multiLanguageSettings. |
getMultiLanguageSettingsBuilder()
public Flow.MultiLanguageSettings.Builder getMultiLanguageSettingsBuilder()Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Flow.MultiLanguageSettings.Builder |
|
getMultiLanguageSettingsOrBuilder()
public Flow.MultiLanguageSettingsOrBuilder getMultiLanguageSettingsOrBuilder()Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Flow.MultiLanguageSettingsOrBuilder |
|
getName()
public String getName() The unique identifier of the flow.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() The unique identifier of the flow.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNluSettings()
public NluSettings getNluSettings()NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Returns | |
|---|---|
| Type | Description |
NluSettings |
The nluSettings. |
getNluSettingsBuilder()
public NluSettings.Builder getNluSettingsBuilder()NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Returns | |
|---|---|
| Type | Description |
NluSettings.Builder |
|
getNluSettingsOrBuilder()
public NluSettingsOrBuilder getNluSettingsOrBuilder()NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Returns | |
|---|---|
| Type | Description |
NluSettingsOrBuilder |
|
getTransitionRouteGroups(int index)
public String getTransitionRouteGroups(int index)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.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)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.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()A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
int |
The count of transitionRouteGroups. |
getTransitionRouteGroupsList()
public ProtocolStringList getTransitionRouteGroupsList()A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the transitionRouteGroups. |
getTransitionRoutes(int index)
public TransitionRoute getTransitionRoutes(int index)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute |
|
getTransitionRoutesBuilder(int index)
public TransitionRoute.Builder getTransitionRoutesBuilder(int index)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRoute.Builder |
|
getTransitionRoutesBuilderList()
public List<TransitionRoute.Builder> getTransitionRoutesBuilderList()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getTransitionRoutesCount()
public int getTransitionRoutesCount()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getTransitionRoutesList()
public List<TransitionRoute> getTransitionRoutesList()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
List<TransitionRoute> |
|
getTransitionRoutesOrBuilder(int index)
public TransitionRouteOrBuilder getTransitionRoutesOrBuilder(int index)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
TransitionRouteOrBuilder |
|
getTransitionRoutesOrBuilderList()
public List<? extends TransitionRouteOrBuilder> getTransitionRoutesOrBuilderList()A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.dialogflow.cx.v3beta1.TransitionRouteOrBuilder> |
|
hasAdvancedSettings()
public boolean hasAdvancedSettings()Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSettings 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. |
hasMultiLanguageSettings()
public boolean hasMultiLanguageSettings()Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the multiLanguageSettings field is set. |
hasNluSettings()
public boolean hasNluSettings()NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the nluSettings 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 Flow.Builder mergeAdvancedSettings(AdvancedSettings value)Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
mergeFrom(Flow other)
public Flow.Builder mergeFrom(Flow other)| Parameter | |
|---|---|
| Name | Description |
other |
Flow |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Flow.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Flow.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
mergeKnowledgeConnectorSettings(KnowledgeConnectorSettings value)
public Flow.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 |
Flow.Builder |
|
mergeMultiLanguageSettings(Flow.MultiLanguageSettings value)
public Flow.Builder mergeMultiLanguageSettings(Flow.MultiLanguageSettings value)Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Flow.MultiLanguageSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
mergeNluSettings(NluSettings value)
public Flow.Builder mergeNluSettings(NluSettings value)NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
NluSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Flow.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
removeEventHandlers(int index)
public Flow.Builder removeEventHandlers(int index)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
removeTransitionRoutes(int index)
public Flow.Builder removeTransitionRoutes(int index)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setAdvancedSettings(AdvancedSettings value)
public Flow.Builder setAdvancedSettings(AdvancedSettings value)Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setAdvancedSettings(AdvancedSettings.Builder builderForValue)
public Flow.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)Hierarchical advanced settings for this flow. The settings exposed at the lower level overrides the settings exposed at the higher level.
.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 14;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AdvancedSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setDescription(String value)
public Flow.Builder setDescription(String value)The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public Flow.Builder setDescriptionBytes(ByteString value)The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setDisplayName(String value)
public Flow.Builder setDisplayName(String value)Required. The human-readable name of the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Flow.Builder setDisplayNameBytes(ByteString value)Required. The human-readable name of the flow.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setEventHandlers(int index, EventHandler value)
public Flow.Builder setEventHandlers(int index, EventHandler value)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
EventHandler |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setEventHandlers(int index, EventHandler.Builder builderForValue)
public Flow.Builder setEventHandlers(int index, EventHandler.Builder builderForValue)A flow's event handlers serve two purposes:
- They are responsible for handling events (e.g. no match, webhook errors) in the flow.
They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow.
Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored.
repeated .google.cloud.dialogflow.cx.v3beta1.EventHandler event_handlers = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
EventHandler.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Flow.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setKnowledgeConnectorSettings(KnowledgeConnectorSettings value)
public Flow.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 |
Flow.Builder |
|
setKnowledgeConnectorSettings(KnowledgeConnectorSettings.Builder builderForValue)
public Flow.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 |
Flow.Builder |
|
setLocked(boolean value)
public Flow.Builder setLocked(boolean value)Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.
bool locked = 30;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe locked to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setMultiLanguageSettings(Flow.MultiLanguageSettings value)
public Flow.Builder setMultiLanguageSettings(Flow.MultiLanguageSettings value)Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Flow.MultiLanguageSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setMultiLanguageSettings(Flow.MultiLanguageSettings.Builder builderForValue)
public Flow.Builder setMultiLanguageSettings(Flow.MultiLanguageSettings.Builder builderForValue)Optional. Multi-lingual agent settings for this flow.
.google.cloud.dialogflow.cx.v3beta1.Flow.MultiLanguageSettings multi_language_settings = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Flow.MultiLanguageSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setName(String value)
public Flow.Builder setName(String value) The unique identifier of the flow.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Flow.Builder setNameBytes(ByteString value) The unique identifier of the flow.
Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
ID>/flows/<Flow ID>.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setNluSettings(NluSettings value)
public Flow.Builder setNluSettings(NluSettings value)NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
NluSettings |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setNluSettings(NluSettings.Builder builderForValue)
public Flow.Builder setNluSettings(NluSettings.Builder builderForValue)NLU related settings of the flow.
.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
NluSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Flow.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setTransitionRouteGroups(int index, String value)
public Flow.Builder setTransitionRouteGroups(int index, String value)A flow's transition route group serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow.
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 = 15 [(.google.api.resource_reference) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe transitionRouteGroups to set. |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
This builder for chaining. |
setTransitionRoutes(int index, TransitionRoute value)
public Flow.Builder setTransitionRoutes(int index, TransitionRoute value)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
TransitionRoute |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setTransitionRoutes(int index, TransitionRoute.Builder builderForValue)
public Flow.Builder setTransitionRoutes(int index, TransitionRoute.Builder builderForValue)A flow's transition routes serve two purposes:
- They are responsible for matching the user's first utterances in the flow.
They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow.
TransitionRoutes are evalauted in the following order:
TransitionRoutes with intent specified.
TransitionRoutes with only condition specified.
TransitionRoutes with intent specified are inherited by pages in the flow.
repeated .google.cloud.dialogflow.cx.v3beta1.TransitionRoute transition_routes = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
TransitionRoute.Builder |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final Flow.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Flow.Builder |
|