Package com.google.cloud.dialogflow.cx.v3beta1

Class Fulfillment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.Fulfillment
All Implemented Interfaces:
FulfillmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Fulfillment extends com.google.protobuf.GeneratedMessage 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.v3beta1.Page] or
 [Form][google.cloud.dialogflow.cx.v3beta1.Form] lifecycle. For example, when
 a
 [DetectIntentRequest][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.QueryResult] in the
 returning
 [DetectIntentResponse][google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse],
 call the webhook (for example, to load user data from a database), or both.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment
See Also:

  • Field Details

    • MESSAGES_FIELD_NUMBER

      public static final int MESSAGES_FIELD_NUMBER
      See Also:

    • WEBHOOK_FIELD_NUMBER

      public static final int WEBHOOK_FIELD_NUMBER
      See Also:

    • RETURN_PARTIAL_RESPONSES_FIELD_NUMBER

      public static final int RETURN_PARTIAL_RESPONSES_FIELD_NUMBER
      See Also:

    • TAG_FIELD_NUMBER

      public static final int TAG_FIELD_NUMBER
      See Also:

    • SET_PARAMETER_ACTIONS_FIELD_NUMBER

      public static final int SET_PARAMETER_ACTIONS_FIELD_NUMBER
      See Also:

    • CONDITIONAL_CASES_FIELD_NUMBER

      public static final int CONDITIONAL_CASES_FIELD_NUMBER
      See Also:

    • ADVANCED_SETTINGS_FIELD_NUMBER

      public static final int ADVANCED_SETTINGS_FIELD_NUMBER
      See Also:

    • ENABLE_GENERATIVE_FALLBACK_FIELD_NUMBER

      public static final int ENABLE_GENERATIVE_FALLBACK_FIELD_NUMBER
      See Also:

    • GENERATORS_FIELD_NUMBER

      public static final int GENERATORS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getMessagesList

      public List<ResponseMessage> getMessagesList()
       The list of rich message responses to present to the user.
      repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
      Specified by:
      getMessagesList in interface FulfillmentOrBuilder

    • getMessagesOrBuilderList

      public List<? extends ResponseMessageOrBuilder> getMessagesOrBuilderList()
       The list of rich message responses to present to the user.
      repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
      Specified by:
      getMessagesOrBuilderList in interface FulfillmentOrBuilder

    • getMessagesCount

      public int getMessagesCount()
       The list of rich message responses to present to the user.
      repeated .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage messages = 1;
      Specified by:
      getMessages in interface FulfillmentOrBuilder

    • getMessagesOrBuilder

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

    • getWebhook

      public String getWebhook()
       The webhook to call.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
      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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
      string webhook = 2 [(.google.api.resource_reference) = { ... }
      Specified by:
      getWebhookBytes in interface FulfillmentOrBuilder
      Returns:
      The bytes for webhook.

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

    • getTag

      public String getTag()
       The value of this field will be populated in the
 [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.

    • getSetParameterActionsList

      public List<Fulfillment.SetParameterAction> getSetParameterActionsList()
       Set parameter values before executing the webhook.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
      Specified by:
      getSetParameterActionsList in interface FulfillmentOrBuilder

    • getSetParameterActionsOrBuilderList

      public List<? extends Fulfillment.SetParameterActionOrBuilder> getSetParameterActionsOrBuilderList()
       Set parameter values before executing the webhook.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
      Specified by:
      getSetParameterActionsOrBuilderList in interface FulfillmentOrBuilder

    • getSetParameterActionsCount

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

    • getSetParameterActions

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

    • getSetParameterActionsOrBuilder

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

    • getConditionalCasesList

      public List<Fulfillment.ConditionalCases> getConditionalCasesList()
       Conditional cases for this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
      Specified by:
      getConditionalCasesList in interface FulfillmentOrBuilder

    • getConditionalCasesOrBuilderList

      public List<? extends Fulfillment.ConditionalCasesOrBuilder> getConditionalCasesOrBuilderList()
       Conditional cases for this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
      Specified by:
      getConditionalCasesOrBuilderList in interface FulfillmentOrBuilder

    • getConditionalCasesCount

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

    • getConditionalCases

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

    • getConditionalCasesOrBuilder

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

    • hasAdvancedSettings

      public boolean hasAdvancedSettings()
       Hierarchical advanced settings for this fulfillment. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
      Specified by:
      hasAdvancedSettings in interface FulfillmentOrBuilder
      Returns:
      Whether the advancedSettings field is set.

    • getAdvancedSettings

      public AdvancedSettings getAdvancedSettings()
       Hierarchical advanced settings for this fulfillment. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
      Specified by:
      getAdvancedSettings in interface FulfillmentOrBuilder
      Returns:
      The advancedSettings.

    • getAdvancedSettingsOrBuilder

      public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
       Hierarchical advanced settings for this fulfillment. The settings exposed
 at the lower level overrides the settings exposed at the higher level.
      .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
      Specified by:
      getAdvancedSettingsOrBuilder in interface FulfillmentOrBuilder

    • getEnableGenerativeFallback

      public boolean getEnableGenerativeFallback()
       If the flag is true, the agent will utilize LLM to generate a text
 response. If LLM generation fails, the defined
 [responses][google.cloud.dialogflow.cx.v3beta1.Fulfillment.messages] in the
 fulfillment will be respected. This flag is only useful for fulfillments
 associated with no-match event handlers.
      bool enable_generative_fallback = 12;
      Specified by:
      getEnableGenerativeFallback in interface FulfillmentOrBuilder
      Returns:
      The enableGenerativeFallback.

    • getGeneratorsList

      public List<Fulfillment.GeneratorSettings> getGeneratorsList()
       A list of Generators to be called during this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.GeneratorSettings generators = 13;
      Specified by:
      getGeneratorsList in interface FulfillmentOrBuilder

    • getGeneratorsOrBuilderList

      public List<? extends Fulfillment.GeneratorSettingsOrBuilder> getGeneratorsOrBuilderList()
       A list of Generators to be called during this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.GeneratorSettings generators = 13;
      Specified by:
      getGeneratorsOrBuilderList in interface FulfillmentOrBuilder

    • getGeneratorsCount

      public int getGeneratorsCount()
       A list of Generators to be called during this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.GeneratorSettings generators = 13;
      Specified by:
      getGeneratorsCount in interface FulfillmentOrBuilder

    • getGenerators

      public Fulfillment.GeneratorSettings getGenerators(int index)
       A list of Generators to be called during this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.GeneratorSettings generators = 13;
      Specified by:
      getGenerators in interface FulfillmentOrBuilder

    • getGeneratorsOrBuilder

      public Fulfillment.GeneratorSettingsOrBuilder getGeneratorsOrBuilder(int index)
       A list of Generators to be called during this fulfillment.
      repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.GeneratorSettings generators = 13;
      Specified by:
      getGeneratorsOrBuilder in interface FulfillmentOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 Fulfillment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Fulfillment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Fulfillment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Fulfillment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Fulfillment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Fulfillment parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Fulfillment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Fulfillment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Fulfillment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Fulfillment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Fulfillment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Fulfillment.Builder newBuilder()

    • newBuilder

      public static Fulfillment.Builder newBuilder(Fulfillment prototype)

    • toBuilder

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

    • newBuilderForType

      protected Fulfillment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Fulfillment getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Fulfillment> parser()

    • getParserForType

      public com.google.protobuf.Parser<Fulfillment> 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.GeneratedMessage

    • getDefaultInstanceForType

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