Package com.google.cloud.dialogflow.cx.v3

Class Form.Parameter.FillBehavior

  • All Implemented Interfaces:
    Form.Parameter.FillBehaviorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Form.Parameter
    public static final class Form.Parameter.FillBehavior
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • INITIAL_PROMPT_FULFILLMENT_FIELD_NUMBER

        public static final int INITIAL_PROMPT_FULFILLMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REPROMPT_EVENT_HANDLERS_FIELD_NUMBER

        public static final int REPROMPT_EVENT_HANDLERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        hasInitialPromptFulfillment in interface Form.Parameter.FillBehaviorOrBuilder
        Returns:
        Whether the initialPromptFulfillment field is set.

      • 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];
        Specified by:
        getInitialPromptFulfillment in interface Form.Parameter.FillBehaviorOrBuilder
        Returns:
        The initialPromptFulfillment.

      • 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;
        Specified by:
        getRepromptEventHandlersList in interface Form.Parameter.FillBehaviorOrBuilder

      • 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;
        Specified by:
        getRepromptEventHandlersOrBuilderList in interface Form.Parameter.FillBehaviorOrBuilder

      • 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;
        Specified by:
        getRepromptEventHandlersCount in interface Form.Parameter.FillBehaviorOrBuilder

      • getRepromptEventHandlers

        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;
        Specified by:
        getRepromptEventHandlers in interface Form.Parameter.FillBehaviorOrBuilder

      • getRepromptEventHandlersOrBuilder

        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;
        Specified by:
        getRepromptEventHandlersOrBuilder in interface Form.Parameter.FillBehaviorOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Form.Parameter.FillBehavior parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Form.Parameter.FillBehavior.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Form.Parameter.FillBehavior.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Form.Parameter.FillBehavior.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Form.Parameter.FillBehavior> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Form.Parameter.FillBehavior getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder