Class Flow.Builder (0.31.0) 

public static final class Flow.Builder extends GeneratedMessageV3.Builder<Flow.Builder> implements FlowOrBuilder

Flows 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.v3.Flow

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Flow.Builder

Implements

FlowOrBuilder

Static 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.v3.EventHandler event_handlers = 10;

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.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>.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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
Overrides

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

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

Parameter
Name Description
value String

The 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>.

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

Parameter
Name Description
value ByteString

The 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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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
Overrides

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.v3.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
Overrides

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.v3.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
Overrides

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

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

Returns
Type Description
Flow.Builder

clone()

public Flow.Builder clone()
Returns
Type Description
Flow.Builder
Overrides

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
Overrides

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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.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.v3.EventHandler event_handlers = 10;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.EventHandlerOrBuilder>

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.v3.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.v3.NluSettings nlu_settings = 11;

Returns
Type Description
NluSettings.Builder

getNluSettingsOrBuilder()

public NluSettingsOrBuilder getNluSettingsOrBuilder()

NLU related settings of the flow.

.google.cloud.dialogflow.cx.v3.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>.

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

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

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

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

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.TransitionRouteOrBuilder>

hasNluSettings()

public boolean hasNluSettings()

NLU related settings of the flow.

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

Returns
Type Description
boolean

Whether the nluSettings field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Flow.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Flow.Builder
Overrides

mergeNluSettings(NluSettings value)

public Flow.Builder mergeNluSettings(NluSettings value)

NLU related settings of the flow.

.google.cloud.dialogflow.cx.v3.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
Overrides

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

Parameter
Name Description
index int
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 String

The 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 ByteString

The 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 String

The 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 ByteString

The 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.v3.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.v3.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
Overrides

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 String

The 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 ByteString

The 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.v3.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.v3.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
Overrides

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

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

Parameters
Name Description
index int

The index to set the value at.
value String

The 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.v3.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.v3.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
Overrides