Interface FlowOrBuilder (0.65.0)

Version 0.65.0

• 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 interface FlowOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdvancedSettings()

public abstract 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.

getAdvancedSettingsOrBuilder()

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

getDescription()

public abstract 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 abstract 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.

getDisplayName()

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

getEventHandlersCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getKnowledgeConnectorSettingsOrBuilder()

public abstract 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 abstract 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 abstract 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.

getMultiLanguageSettingsOrBuilder()

public abstract 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 abstract String getName()

The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The unique identifier of the flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getNluSettings()

public abstract NluSettings getNluSettings()

NLU related settings of the flow.

.google.cloud.dialogflow.cx.v3beta1.NluSettings nlu_settings = 11;

Returns
Type	Description
NluSettings	The nluSettings.

getNluSettingsOrBuilder()

public abstract 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 abstract 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.

repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The transitionRouteGroups at the given index.

getTransitionRouteGroupsBytes(int index)

public abstract 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.

repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the transitionRouteGroups at the given index.

getTransitionRouteGroupsCount()

public abstract 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.

repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
int	The count of transitionRouteGroups.

getTransitionRouteGroupsList()

public abstract List<String> 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/transitionRouteGroups/<TransitionRouteGroupID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/transitionRouteGroups/<TransitionRouteGroupID> for agent-level groups.

repeated string transition_route_groups = 15 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
List<String>	A list containing the transitionRouteGroups.

getTransitionRoutes(int index)

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

getTransitionRoutesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.