Interface Form.Parameter.FillBehaviorOrBuilder (0.40.0)

Version 0.40.0

• 0.64.0 (latest)
• 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 interface Form.Parameter.FillBehaviorOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getInitialPromptFulfillment()

public abstract Fulfillment getInitialPromptFulfillment()

Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

.google.cloud.dialogflow.cx.v3.Fulfillment initial_prompt_fulfillment = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Fulfillment	The initialPromptFulfillment.

getInitialPromptFulfillmentOrBuilder()

public abstract FulfillmentOrBuilder getInitialPromptFulfillmentOrBuilder()

Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

.google.cloud.dialogflow.cx.v3.Fulfillment initial_prompt_fulfillment = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
FulfillmentOrBuilder

getRepromptEventHandlers(int index)

public abstract EventHandler getRepromptEventHandlers(int index)

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

• sys.no-match-<N>, where N can be from 1 to 6
• sys.no-match-default
• sys.no-input-<N>, where N can be from 1 to 6
• sys.no-input-default

• sys.invalid-parameter

  initial_prompt_fulfillment provides the first prompt for the parameter.

  If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

  A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

  A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

  If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

repeated .google.cloud.dialogflow.cx.v3.EventHandler reprompt_event_handlers = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
EventHandler

getRepromptEventHandlersCount()

public abstract int getRepromptEventHandlersCount()

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

• sys.no-match-<N>, where N can be from 1 to 6
• sys.no-match-default
• sys.no-input-<N>, where N can be from 1 to 6
• sys.no-input-default

• sys.invalid-parameter

  initial_prompt_fulfillment provides the first prompt for the parameter.

  If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

  A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

  A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

  If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

repeated .google.cloud.dialogflow.cx.v3.EventHandler reprompt_event_handlers = 5;

Returns
Type	Description
int

getRepromptEventHandlersList()

public abstract List<EventHandler> getRepromptEventHandlersList()

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

• sys.no-match-<N>, where N can be from 1 to 6
• sys.no-match-default
• sys.no-input-<N>, where N can be from 1 to 6
• sys.no-input-default

• sys.invalid-parameter

  initial_prompt_fulfillment provides the first prompt for the parameter.

  If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

  A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

  A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

  If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

repeated .google.cloud.dialogflow.cx.v3.EventHandler reprompt_event_handlers = 5;

Returns
Type	Description
List<EventHandler>

getRepromptEventHandlersOrBuilder(int index)

public abstract EventHandlerOrBuilder getRepromptEventHandlersOrBuilder(int index)

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

• sys.no-match-<N>, where N can be from 1 to 6
• sys.no-match-default
• sys.no-input-<N>, where N can be from 1 to 6
• sys.no-input-default

• sys.invalid-parameter

  initial_prompt_fulfillment provides the first prompt for the parameter.

  If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

  A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

  A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

  If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

repeated .google.cloud.dialogflow.cx.v3.EventHandler reprompt_event_handlers = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
EventHandlerOrBuilder

getRepromptEventHandlersOrBuilderList()

public abstract List<? extends EventHandlerOrBuilder> getRepromptEventHandlersOrBuilderList()

The handlers for parameter-level events, used to provide reprompt for the parameter or transition to a different page/flow. The supported events are:

• sys.no-match-<N>, where N can be from 1 to 6
• sys.no-match-default
• sys.no-input-<N>, where N can be from 1 to 6
• sys.no-input-default

• sys.invalid-parameter

  initial_prompt_fulfillment provides the first prompt for the parameter.

  If the user's response does not fill the parameter, a no-match/no-input event will be triggered, and the fulfillment associated with the sys.no-match-1/sys.no-input-1 handler (if defined) will be called to provide a prompt. The sys.no-match-2/sys.no-input-2 handler (if defined) will respond to the next no-match/no-input event, and so on.

  A sys.no-match-default or sys.no-input-default handler will be used to handle all following no-match/no-input events after all numbered no-match/no-input handlers for the parameter are consumed.

  A sys.invalid-parameter handler can be defined to handle the case where the parameter values have been invalidated by webhook. For example, if the user's response fill the parameter, however the parameter was invalidated by webhook, the fulfillment associated with the sys.invalid-parameter handler (if defined) will be called to provide a prompt.

  If the event handler for the corresponding event can't be found on the parameter, initial_prompt_fulfillment will be re-prompted.

repeated .google.cloud.dialogflow.cx.v3.EventHandler reprompt_event_handlers = 5;

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

hasInitialPromptFulfillment()

public abstract boolean hasInitialPromptFulfillment()

Required. The fulfillment to provide the initial prompt that the agent can present to the user in order to fill the parameter.

.google.cloud.dialogflow.cx.v3.Fulfillment initial_prompt_fulfillment = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the initialPromptFulfillment field is set.