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 Summary

Modifier and Type	Method and Description
AdvancedSettings	getAdvancedSettings() Hierarchical advanced settings for this fulfillment.
AdvancedSettingsOrBuilder	getAdvancedSettingsOrBuilder() Hierarchical advanced settings for this fulfillment.
Fulfillment.ConditionalCases	getConditionalCases(int index) Conditional cases for this fulfillment.
int	getConditionalCasesCount() Conditional cases for this fulfillment.
List<Fulfillment.ConditionalCases>	getConditionalCasesList() Conditional cases for this fulfillment.
Fulfillment.ConditionalCasesOrBuilder	getConditionalCasesOrBuilder(int index) Conditional cases for this fulfillment.
List<? extends Fulfillment.ConditionalCasesOrBuilder>	getConditionalCasesOrBuilderList() Conditional cases for this fulfillment.
boolean	getEnableGenerativeFallback() If the flag is true, the agent will utilize LLM to generate a text response.
ResponseMessage	getMessages(int index) The list of rich message responses to present to the user.
int	getMessagesCount() The list of rich message responses to present to the user.
List<ResponseMessage>	getMessagesList() The list of rich message responses to present to the user.
ResponseMessageOrBuilder	getMessagesOrBuilder(int index) The list of rich message responses to present to the user.
List<? extends ResponseMessageOrBuilder>	getMessagesOrBuilderList() The list of rich message responses to present to the user.
boolean	getReturnPartialResponses() Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs.
Fulfillment.SetParameterAction	getSetParameterActions(int index) Set parameter values before executing the webhook.
int	getSetParameterActionsCount() Set parameter values before executing the webhook.
List<Fulfillment.SetParameterAction>	getSetParameterActionsList() Set parameter values before executing the webhook.
Fulfillment.SetParameterActionOrBuilder	getSetParameterActionsOrBuilder(int index) Set parameter values before executing the webhook.
List<? extends Fulfillment.SetParameterActionOrBuilder>	getSetParameterActionsOrBuilderList() Set parameter values before executing the webhook.
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.
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.
String	getWebhook() The webhook to call.
com.google.protobuf.ByteString	getWebhookBytes() The webhook to call.
boolean	hasAdvancedSettings() Hierarchical advanced settings for this fulfillment.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
 

string webhook = 2 [(.google.api.resource_reference) = { ... }

Returns:

The webhook.

getWebhookBytes

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) = { ... }

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;

hasAdvancedSettings

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.v3.AdvancedSettings advanced_settings = 7;

Returns:

Whether the advancedSettings field is set.

getAdvancedSettings

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.v3.AdvancedSettings advanced_settings = 7;

Returns:

The advancedSettings.

getAdvancedSettingsOrBuilder

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.v3.AdvancedSettings advanced_settings = 7;

getEnableGenerativeFallback

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.v3.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;

Returns:

The enableGenerativeFallback.