Class Form.Parameter.FillBehavior (0.40.0)

public static final class Form.Parameter.FillBehavior extends GeneratedMessageV3 implements Form.Parameter.FillBehaviorOrBuilder

Configuration for how the filling of a parameter should be handled.

Protobuf type google.cloud.dialogflow.cx.v3.Form.Parameter.FillBehavior

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Form.Parameter.FillBehavior

Static Fields

INITIAL_PROMPT_FULFILLMENT_FIELD_NUMBER

public static final int INITIAL_PROMPT_FULFILLMENT_FIELD_NUMBER
Field Value
TypeDescription
int

REPROMPT_EVENT_HANDLERS_FIELD_NUMBER

public static final int REPROMPT_EVENT_HANDLERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Form.Parameter.FillBehavior getDefaultInstance()
Returns
TypeDescription
Form.Parameter.FillBehavior

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Form.Parameter.FillBehavior.Builder newBuilder()
Returns
TypeDescription
Form.Parameter.FillBehavior.Builder

newBuilder(Form.Parameter.FillBehavior )

public static Form.Parameter.FillBehavior.Builder newBuilder(Form.Parameter.FillBehavior )
Parameter
NameDescription
Form.Parameter.FillBehavior
Returns
TypeDescription
Form.Parameter.FillBehavior.Builder

parseDelimitedFrom(InputStream input)

public static Form.Parameter.FillBehavior parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Form.Parameter.FillBehavior parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Form.Parameter.FillBehavior parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Form.Parameter.FillBehavior parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Form.Parameter.FillBehavior parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Form.Parameter.FillBehavior parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Form.Parameter.FillBehavior parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Form.Parameter.FillBehavior
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Form.Parameter.FillBehavior> parser()
Returns
TypeDescription
Parser<FillBehavior>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Form.Parameter.FillBehavior getDefaultInstanceForType()
Returns
TypeDescription
Form.Parameter.FillBehavior

getInitialPromptFulfillment()

public 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
TypeDescription
Fulfillment

The initialPromptFulfillment.

getInitialPromptFulfillmentOrBuilder()

public 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
TypeDescription
FulfillmentOrBuilder

getParserForType()

public Parser<Form.Parameter.FillBehavior> getParserForType()
Returns
TypeDescription
Parser<FillBehavior>
Overrides

getRepromptEventHandlers(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
EventHandler

getRepromptEventHandlersCount()

public 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
TypeDescription
int

getRepromptEventHandlersList()

public 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
TypeDescription
List<EventHandler>

getRepromptEventHandlersOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
EventHandlerOrBuilder

getRepromptEventHandlersOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.dialogflow.cx.v3.EventHandlerOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasInitialPromptFulfillment()

public 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
TypeDescription
boolean

Whether the initialPromptFulfillment field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Form.Parameter.FillBehavior.Builder newBuilderForType()
Returns
TypeDescription
Form.Parameter.FillBehavior.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Form.Parameter.FillBehavior.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Form.Parameter.FillBehavior.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Form.Parameter.FillBehavior.Builder toBuilder()
Returns
TypeDescription
Form.Parameter.FillBehavior.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException