com.google.cloud.dialogflow.cx.v3

Interface FlowOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Flow, Flow.Builder

public interface FlowOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDescription() The description of the flow.
com.google.protobuf.ByteString	getDescriptionBytes() The description of the flow.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
EventHandler	getEventHandlers(int index) A flow's event handlers serve two purposes: * They are responsible for handling events (e.g.
int	getEventHandlersCount() A flow's event handlers serve two purposes: * They are responsible for handling events (e.g.
List<EventHandler>	getEventHandlersList() A flow's event handlers serve two purposes: * They are responsible for handling events (e.g.
EventHandlerOrBuilder	getEventHandlersOrBuilder(int index) A flow's event handlers serve two purposes: * They are responsible for handling events (e.g.
List<? extends EventHandlerOrBuilder>	getEventHandlersOrBuilderList() A flow's event handlers serve two purposes: * They are responsible for handling events (e.g.
String	getName() The unique identifier of the flow.
com.google.protobuf.ByteString	getNameBytes() The unique identifier of the flow.
NluSettings	getNluSettings() NLU related settings of the flow.
NluSettingsOrBuilder	getNluSettingsOrBuilder() NLU related settings of the flow.
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.
com.google.protobuf.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.
int	getTransitionRouteGroupsCount() A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow.
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.
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.
int	getTransitionRoutesCount() A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow.
List<TransitionRoute>	getTransitionRoutesList() A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow.
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.
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.
boolean	hasNluSettings() NLU related settings of the flow.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

String getDisplayName()

 Required. The human-readable name of the flow.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The human-readable name of the flow.
 

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for displayName.

getDescription

String getDescription()

 The description of the flow. The maximum length is 500 characters. If
 exceeded, the request is rejected.
 

string description = 3;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 The description of the flow. The maximum length is 500 characters. If
 exceeded, the request is rejected.
 

string description = 3;

Returns:

The bytes for description.

getTransitionRoutesList

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][Page.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.v3.TransitionRoute transition_routes = 4;

getTransitionRoutes

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][Page.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.v3.TransitionRoute transition_routes = 4;

getTransitionRoutesCount

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][Page.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.v3.TransitionRoute transition_routes = 4;

getTransitionRoutesOrBuilderList

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][Page.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.v3.TransitionRoute transition_routes = 4;

getTransitionRoutesOrBuilder

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][Page.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.v3.TransitionRoute transition_routes = 4;

getEventHandlersList

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][Page.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][google.cloud.dialogflow.cx.v3.Flow.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.v3.EventHandler event_handlers = 10;

getEventHandlers

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][Page.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][google.cloud.dialogflow.cx.v3.Flow.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.v3.EventHandler event_handlers = 10;

getEventHandlersCount

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][Page.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][google.cloud.dialogflow.cx.v3.Flow.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.v3.EventHandler event_handlers = 10;

getEventHandlersOrBuilderList

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][Page.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][google.cloud.dialogflow.cx.v3.Flow.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.v3.EventHandler event_handlers = 10;

getEventHandlersOrBuilder

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][Page.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][google.cloud.dialogflow.cx.v3.Flow.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.v3.EventHandler event_handlers = 10;

getTransitionRouteGroupsList

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][Page.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>`.
 

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

Returns:

A list containing the transitionRouteGroups.

getTransitionRouteGroupsCount

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][Page.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>`.
 

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

Returns:

The count of transitionRouteGroups.

getTransitionRouteGroups

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][Page.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>`.
 

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

Parameters:

index - The index of the element to return.

Returns:

The transitionRouteGroups at the given index.

getTransitionRouteGroupsBytes

com.google.protobuf.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][Page.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>`.
 

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the transitionRouteGroups at the given index.

hasNluSettings

boolean hasNluSettings()

 NLU related settings of the flow.
 

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

Returns:

Whether the nluSettings field is set.

getNluSettings

NluSettings getNluSettings()

 NLU related settings of the flow.
 

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

Returns:

The nluSettings.

getNluSettingsOrBuilder

NluSettingsOrBuilder getNluSettingsOrBuilder()

 NLU related settings of the flow.
 

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