Interface FulfillmentOrBuilder (0.43.0)

Version 0.43.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public interface FulfillmentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdvancedSettings()

public abstract 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;

Returns
Type	Description
AdvancedSettings	The advancedSettings.

getAdvancedSettingsOrBuilder()

public abstract 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;

Returns
Type	Description
AdvancedSettingsOrBuilder

getConditionalCases(int index)

public abstract Fulfillment.ConditionalCases getConditionalCases(int index)

Conditional cases for this fulfillment.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Fulfillment.ConditionalCases

getConditionalCasesCount()

public abstract int getConditionalCasesCount()

Conditional cases for this fulfillment.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;

Returns
Type	Description
int

getConditionalCasesList()

public abstract List<Fulfillment.ConditionalCases> getConditionalCasesList()

Conditional cases for this fulfillment.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;

Returns
Type	Description
List<ConditionalCases>

getConditionalCasesOrBuilder(int index)

public abstract Fulfillment.ConditionalCasesOrBuilder getConditionalCasesOrBuilder(int index)

Conditional cases for this fulfillment.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Fulfillment.ConditionalCasesOrBuilder

getConditionalCasesOrBuilderList()

public abstract List<? extends Fulfillment.ConditionalCasesOrBuilder> getConditionalCasesOrBuilderList()

Conditional cases for this fulfillment.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCasesOrBuilder>

getEnableGenerativeFallback()

public abstract boolean getEnableGenerativeFallback()

If the flag is true, the agent will utilize LLM to generate a text response. If LLM generation fails, the defined responses 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
Type	Description
boolean	The enableGenerativeFallback.

getMessages(int index)

public abstract ResponseMessage getMessages(int index)

The list of rich message responses to present to the user.

repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ResponseMessage

getMessagesCount()

public abstract int getMessagesCount()

The list of rich message responses to present to the user.

repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;

Returns
Type	Description
int

getMessagesList()

public abstract List<ResponseMessage> getMessagesList()

The list of rich message responses to present to the user.

repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;

Returns
Type	Description
List<ResponseMessage>

getMessagesOrBuilder(int index)

public abstract ResponseMessageOrBuilder getMessagesOrBuilder(int index)

The list of rich message responses to present to the user.

repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ResponseMessageOrBuilder

getMessagesOrBuilderList()

public abstract List<? extends ResponseMessageOrBuilder> getMessagesOrBuilderList()

The list of rich message responses to present to the user.

repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.ResponseMessageOrBuilder>

getReturnPartialResponses()

public abstract 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
Type	Description
boolean	The returnPartialResponses.

getSetParameterActions(int index)

public abstract Fulfillment.SetParameterAction getSetParameterActions(int index)

Set parameter values before executing the webhook.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Fulfillment.SetParameterAction

getSetParameterActionsCount()

public abstract int getSetParameterActionsCount()

Set parameter values before executing the webhook.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;

Returns
Type	Description
int

getSetParameterActionsList()

public abstract List<Fulfillment.SetParameterAction> getSetParameterActionsList()

Set parameter values before executing the webhook.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;

Returns
Type	Description
List<SetParameterAction>

getSetParameterActionsOrBuilder(int index)

public abstract Fulfillment.SetParameterActionOrBuilder getSetParameterActionsOrBuilder(int index)

Set parameter values before executing the webhook.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Fulfillment.SetParameterActionOrBuilder

getSetParameterActionsOrBuilderList()

public abstract List<? extends Fulfillment.SetParameterActionOrBuilder> getSetParameterActionsOrBuilderList()

Set parameter values before executing the webhook.

repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;

Returns
Type	Description
List<? extends com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterActionOrBuilder>

getTag()

public abstract String getTag()

The value of this field will be populated in the 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
Type	Description
String	The tag.

getTagBytes()

public abstract ByteString getTagBytes()

The value of this field will be populated in the 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
Type	Description
ByteString	The bytes for tag.

getWebhook()

public abstract 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
Type	Description
String	The webhook.

getWebhookBytes()

public abstract 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
Type	Description
ByteString	The bytes for webhook.

hasAdvancedSettings()

public abstract 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;

Returns
Type	Description
boolean	Whether the advancedSettings field is set.