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

Class Fulfillment.Builder

  • All Implemented Interfaces:
    FulfillmentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Fulfillment
    public static final class Fulfillment.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>
implements FulfillmentOrBuilder
     A fulfillment can do one or more of the following actions at the same time:

   * Generate rich message responses.
   * Set parameter values.
   * Call the webhook.

 Fulfillments can be called at various stages in the
 [Page][google.cloud.dialogflow.cx.v3.Page] or
 [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a
 [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest]
 drives a session to enter a new page, the page's entry fulfillment can add a
 static response to the
 [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning
 [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse],
 call the webhook (for example, to load user data from a database), or both.
    Protobuf type google.cloud.dialogflow.cx.v3.Fulfillment

    • Method Detail

      • 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.Builder<Fulfillment.Builder>

      • clear

        public Fulfillment.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • getDefaultInstanceForType

        public Fulfillment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Fulfillment build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Fulfillment buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Fulfillment.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • setField

        public Fulfillment.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • clearField

        public Fulfillment.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • clearOneof

        public Fulfillment.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • setRepeatedField

        public Fulfillment.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • addRepeatedField

        public Fulfillment.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • mergeFrom

        public Fulfillment.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Fulfillment.Builder>

      • isInitialized

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

      • mergeFrom

        public Fulfillment.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Fulfillment.Builder>
        Throws:
        IOException

      • getMessagesCount

        public int getMessagesCount()
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
        Specified by:
        getMessagesCount in interface FulfillmentOrBuilder

      • getMessages

        public ResponseMessage getMessages​(int index)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
        Specified by:
        getMessages in interface FulfillmentOrBuilder

      • setMessages

        public Fulfillment.Builder setMessages​(int index,
                                       ResponseMessage value)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • setMessages

        public Fulfillment.Builder setMessages​(int index,
                                       ResponseMessage.Builder builderForValue)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessages

        public Fulfillment.Builder addMessages​(ResponseMessage value)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessages

        public Fulfillment.Builder addMessages​(int index,
                                       ResponseMessage value)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessages

        public Fulfillment.Builder addMessages​(ResponseMessage.Builder builderForValue)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessages

        public Fulfillment.Builder addMessages​(int index,
                                       ResponseMessage.Builder builderForValue)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addAllMessages

        public Fulfillment.Builder addAllMessages​(Iterable<? extends ResponseMessage> values)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • clearMessages

        public Fulfillment.Builder clearMessages()
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • removeMessages

        public Fulfillment.Builder removeMessages​(int index)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • getMessagesBuilder

        public ResponseMessage.Builder getMessagesBuilder​(int index)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessagesBuilder

        public ResponseMessage.Builder addMessagesBuilder()
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • addMessagesBuilder

        public ResponseMessage.Builder addMessagesBuilder​(int index)
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • getMessagesBuilderList

        public List<ResponseMessage.Builder> getMessagesBuilderList()
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • getWebhook

        public String getWebhook()
         The webhook to call.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/webhooks/<Webhook ID>`.
        string webhook = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getWebhook in interface FulfillmentOrBuilder
        Returns:
        The webhook.

      • getWebhookBytes

        public com.google.protobuf.ByteString getWebhookBytes()
         The webhook to call.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/webhooks/<Webhook ID>`.
        string webhook = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getWebhookBytes in interface FulfillmentOrBuilder
        Returns:
        The bytes for webhook.

      • setWebhook

        public Fulfillment.Builder setWebhook​(String value)
         The webhook to call.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/webhooks/<Webhook ID>`.
        string webhook = 2 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The webhook to set.
        Returns:
        This builder for chaining.

      • clearWebhook

        public Fulfillment.Builder clearWebhook()
         The webhook to call.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/webhooks/<Webhook ID>`.
        string webhook = 2 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setWebhookBytes

        public Fulfillment.Builder setWebhookBytes​(com.google.protobuf.ByteString value)
         The webhook to call.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/webhooks/<Webhook ID>`.
        string webhook = 2 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for webhook to set.
        Returns:
        This builder for chaining.

      • getReturnPartialResponses

        public boolean getReturnPartialResponses()
         Whether Dialogflow should return currently queued fulfillment response
 messages in streaming APIs. If a webhook is specified, it happens before
 Dialogflow invokes webhook.
 Warning:
 1) This flag only affects streaming API. Responses are still queued
 and returned once in non-streaming API.
 2) The flag can be enabled in any fulfillment but only the first 3 partial
 responses will be returned. You may only want to apply it to fulfillments
 that have slow webhooks.
        bool return_partial_responses = 8;
        Specified by:
        getReturnPartialResponses in interface FulfillmentOrBuilder
        Returns:
        The returnPartialResponses.

      • setReturnPartialResponses

        public Fulfillment.Builder setReturnPartialResponses​(boolean value)
         Whether Dialogflow should return currently queued fulfillment response
 messages in streaming APIs. If a webhook is specified, it happens before
 Dialogflow invokes webhook.
 Warning:
 1) This flag only affects streaming API. Responses are still queued
 and returned once in non-streaming API.
 2) The flag can be enabled in any fulfillment but only the first 3 partial
 responses will be returned. You may only want to apply it to fulfillments
 that have slow webhooks.
        bool return_partial_responses = 8;
        Parameters:
        value - The returnPartialResponses to set.
        Returns:
        This builder for chaining.

      • clearReturnPartialResponses

        public Fulfillment.Builder clearReturnPartialResponses()
         Whether Dialogflow should return currently queued fulfillment response
 messages in streaming APIs. If a webhook is specified, it happens before
 Dialogflow invokes webhook.
 Warning:
 1) This flag only affects streaming API. Responses are still queued
 and returned once in non-streaming API.
 2) The flag can be enabled in any fulfillment but only the first 3 partial
 responses will be returned. You may only want to apply it to fulfillments
 that have slow webhooks.
        bool return_partial_responses = 8;
        Returns:
        This builder for chaining.

      • getTag

        public String getTag()
         The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
 `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
 called.
 The tag is typically used by the webhook service to identify which
 fulfillment is being called, but it could be used for other purposes.
 This field is required if `webhook` is specified.
        string tag = 3;
        Specified by:
        getTag in interface FulfillmentOrBuilder
        Returns:
        The tag.

      • getTagBytes

        public com.google.protobuf.ByteString getTagBytes()
         The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
 `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
 called.
 The tag is typically used by the webhook service to identify which
 fulfillment is being called, but it could be used for other purposes.
 This field is required if `webhook` is specified.
        string tag = 3;
        Specified by:
        getTagBytes in interface FulfillmentOrBuilder
        Returns:
        The bytes for tag.

      • setTag

        public Fulfillment.Builder setTag​(String value)
         The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
 `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
 called.
 The tag is typically used by the webhook service to identify which
 fulfillment is being called, but it could be used for other purposes.
 This field is required if `webhook` is specified.
        string tag = 3;
        Parameters:
        value - The tag to set.
        Returns:
        This builder for chaining.

      • clearTag

        public Fulfillment.Builder clearTag()
         The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
 `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
 called.
 The tag is typically used by the webhook service to identify which
 fulfillment is being called, but it could be used for other purposes.
 This field is required if `webhook` is specified.
        string tag = 3;
        Returns:
        This builder for chaining.

      • setTagBytes

        public Fulfillment.Builder setTagBytes​(com.google.protobuf.ByteString value)
         The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]
 `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
 called.
 The tag is typically used by the webhook service to identify which
 fulfillment is being called, but it could be used for other purposes.
 This field is required if `webhook` is specified.
        string tag = 3;
        Parameters:
        value - The bytes for tag to set.
        Returns:
        This builder for chaining.

      • getSetParameterActionsCount

        public int getSetParameterActionsCount()
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
        Specified by:
        getSetParameterActionsCount in interface FulfillmentOrBuilder

      • setSetParameterActions

        public Fulfillment.Builder setSetParameterActions​(int index,
                                                  Fulfillment.SetParameterAction value)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • setSetParameterActions

        public Fulfillment.Builder setSetParameterActions​(int index,
                                                  Fulfillment.SetParameterAction.Builder builderForValue)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActions

        public Fulfillment.Builder addSetParameterActions​(Fulfillment.SetParameterAction value)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActions

        public Fulfillment.Builder addSetParameterActions​(int index,
                                                  Fulfillment.SetParameterAction value)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActions

        public Fulfillment.Builder addSetParameterActions​(Fulfillment.SetParameterAction.Builder builderForValue)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActions

        public Fulfillment.Builder addSetParameterActions​(int index,
                                                  Fulfillment.SetParameterAction.Builder builderForValue)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addAllSetParameterActions

        public Fulfillment.Builder addAllSetParameterActions​(Iterable<? extends Fulfillment.SetParameterAction> values)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • clearSetParameterActions

        public Fulfillment.Builder clearSetParameterActions()
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • removeSetParameterActions

        public Fulfillment.Builder removeSetParameterActions​(int index)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • getSetParameterActionsBuilder

        public Fulfillment.SetParameterAction.Builder getSetParameterActionsBuilder​(int index)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActionsBuilder

        public Fulfillment.SetParameterAction.Builder addSetParameterActionsBuilder()
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • addSetParameterActionsBuilder

        public Fulfillment.SetParameterAction.Builder addSetParameterActionsBuilder​(int index)
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • getSetParameterActionsBuilderList

        public List<Fulfillment.SetParameterAction.Builder> getSetParameterActionsBuilderList()
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • getConditionalCasesCount

        public int getConditionalCasesCount()
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
        Specified by:
        getConditionalCasesCount in interface FulfillmentOrBuilder

      • setConditionalCases

        public Fulfillment.Builder setConditionalCases​(int index,
                                               Fulfillment.ConditionalCases value)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • addConditionalCases

        public Fulfillment.Builder addConditionalCases​(Fulfillment.ConditionalCases value)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • addConditionalCases

        public Fulfillment.Builder addConditionalCases​(int index,
                                               Fulfillment.ConditionalCases value)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • clearConditionalCases

        public Fulfillment.Builder clearConditionalCases()
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • removeConditionalCases

        public Fulfillment.Builder removeConditionalCases​(int index)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • getConditionalCasesBuilder

        public Fulfillment.ConditionalCases.Builder getConditionalCasesBuilder​(int index)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • addConditionalCasesBuilder

        public Fulfillment.ConditionalCases.Builder addConditionalCasesBuilder()
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • addConditionalCasesBuilder

        public Fulfillment.ConditionalCases.Builder addConditionalCasesBuilder​(int index)
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • getConditionalCasesBuilderList

        public List<Fulfillment.ConditionalCases.Builder> getConditionalCasesBuilderList()
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • setUnknownFields

        public final Fulfillment.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>

      • mergeUnknownFields

        public final Fulfillment.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Fulfillment.Builder>