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

Interface FulfillmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Fulfillment, Fulfillment.Builder
    public interface FulfillmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getMessagesList

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

      • getMessages

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

      • getMessagesCount

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

      • getMessagesOrBuilderList

        List<? extends ResponseMessageOrBuilder> getMessagesOrBuilderList()
         The list of rich message responses to present to the user.
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;

      • getMessagesOrBuilder

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

      • getWebhook

        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) = { ... }
        Returns:
        The webhook.

      • getWebhookBytes

        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) = { ... }
        Returns:
        The bytes for webhook.

      • getReturnPartialResponses

        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;
        Returns:
        The returnPartialResponses.

      • getTag

        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;
        Returns:
        The tag.

      • getTagBytes

        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;
        Returns:
        The bytes for tag.

      • getSetParameterActionsList

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

      • getSetParameterActions

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

      • getSetParameterActionsCount

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

      • getSetParameterActionsOrBuilderList

        List<? extends Fulfillment.SetParameterActionOrBuilder> getSetParameterActionsOrBuilderList()
         Set parameter values before executing the webhook.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;

      • getSetParameterActionsOrBuilder

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

      • getConditionalCasesList

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

      • getConditionalCases

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

      • getConditionalCasesCount

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

      • getConditionalCasesOrBuilderList

        List<? extends Fulfillment.ConditionalCasesOrBuilder> getConditionalCasesOrBuilderList()
         Conditional cases for this fulfillment.
        repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;

      • getConditionalCasesOrBuilder

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