- 0.66.0 (latest)
- 0.65.0
- 0.64.0
- 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 static final class Fulfillment.Builder extends GeneratedMessageV3.Builder<Fulfillment.Builder> implements FulfillmentOrBuilderA 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 or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both.
Protobuf type google.cloud.dialogflow.cx.v3beta1.Fulfillment
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Fulfillment.BuilderImplements
FulfillmentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllConditionalCases(Iterable<? extends Fulfillment.ConditionalCases> values)
public Fulfillment.Builder addAllConditionalCases(Iterable<? extends Fulfillment.ConditionalCases> values)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases> |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addAllMessages(Iterable<? extends ResponseMessage> values)
public Fulfillment.Builder addAllMessages(Iterable<? extends ResponseMessage> values)The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage> |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addAllSetParameterActions(Iterable<? extends Fulfillment.SetParameterAction> values)
public Fulfillment.Builder addAllSetParameterActions(Iterable<? extends Fulfillment.SetParameterAction> values)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction> |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addConditionalCases(Fulfillment.ConditionalCases value)
public Fulfillment.Builder addConditionalCases(Fulfillment.ConditionalCases value)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
Fulfillment.ConditionalCases |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addConditionalCases(Fulfillment.ConditionalCases.Builder builderForValue)
public Fulfillment.Builder addConditionalCases(Fulfillment.ConditionalCases.Builder builderForValue)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Fulfillment.ConditionalCases.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addConditionalCases(int index, Fulfillment.ConditionalCases value)
public Fulfillment.Builder addConditionalCases(int index, Fulfillment.ConditionalCases value)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Fulfillment.ConditionalCases |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addConditionalCases(int index, Fulfillment.ConditionalCases.Builder builderForValue)
public Fulfillment.Builder addConditionalCases(int index, Fulfillment.ConditionalCases.Builder builderForValue)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Fulfillment.ConditionalCases.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addConditionalCasesBuilder()
public Fulfillment.ConditionalCases.Builder addConditionalCasesBuilder()Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.ConditionalCases.Builder |
|
addConditionalCasesBuilder(int index)
public Fulfillment.ConditionalCases.Builder addConditionalCasesBuilder(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.Builder |
|
addMessages(ResponseMessage value)
public Fulfillment.Builder addMessages(ResponseMessage value)The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ResponseMessage |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addMessages(ResponseMessage.Builder builderForValue)
public Fulfillment.Builder addMessages(ResponseMessage.Builder builderForValue)The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ResponseMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addMessages(int index, ResponseMessage value)
public Fulfillment.Builder addMessages(int index, ResponseMessage value)The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ResponseMessage |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addMessages(int index, ResponseMessage.Builder builderForValue)
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.v3beta1.ResponseMessage messages = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ResponseMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addMessagesBuilder()
public ResponseMessage.Builder addMessagesBuilder()The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Returns | |
|---|---|
| Type | Description |
ResponseMessage.Builder |
|
addMessagesBuilder(int index)
public ResponseMessage.Builder addMessagesBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Fulfillment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addSetParameterActions(Fulfillment.SetParameterAction value)
public Fulfillment.Builder addSetParameterActions(Fulfillment.SetParameterAction value)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Fulfillment.SetParameterAction |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addSetParameterActions(Fulfillment.SetParameterAction.Builder builderForValue)
public Fulfillment.Builder addSetParameterActions(Fulfillment.SetParameterAction.Builder builderForValue)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Fulfillment.SetParameterAction.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addSetParameterActions(int index, Fulfillment.SetParameterAction value)
public Fulfillment.Builder addSetParameterActions(int index, Fulfillment.SetParameterAction value)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Fulfillment.SetParameterAction |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addSetParameterActions(int index, Fulfillment.SetParameterAction.Builder builderForValue)
public Fulfillment.Builder addSetParameterActions(int index, Fulfillment.SetParameterAction.Builder builderForValue)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Fulfillment.SetParameterAction.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
addSetParameterActionsBuilder()
public Fulfillment.SetParameterAction.Builder addSetParameterActionsBuilder()Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.SetParameterAction.Builder |
|
addSetParameterActionsBuilder(int index)
public Fulfillment.SetParameterAction.Builder addSetParameterActionsBuilder(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.Builder |
|
build()
public Fulfillment build()| Returns | |
|---|---|
| Type | Description |
Fulfillment |
|
buildPartial()
public Fulfillment buildPartial()| Returns | |
|---|---|
| Type | Description |
Fulfillment |
|
clear()
public Fulfillment.Builder clear()| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
clearAdvancedSettings()
public Fulfillment.Builder clearAdvancedSettings()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 |
Fulfillment.Builder |
|
clearConditionalCases()
public Fulfillment.Builder clearConditionalCases()Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
clearEnableGenerativeFallback()
public Fulfillment.Builder clearEnableGenerativeFallback()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 |
Fulfillment.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Fulfillment.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
clearMessages()
public Fulfillment.Builder clearMessages()The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Fulfillment.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
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 | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
clearSetParameterActions()
public Fulfillment.Builder clearSetParameterActions()Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
clearTag()
public Fulfillment.Builder clearTag() 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 |
Fulfillment.Builder |
This builder for chaining. |
clearWebhook()
public Fulfillment.Builder clearWebhook() The webhook to call.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
string webhook = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
clone()
public Fulfillment.Builder clone()| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettings |
The advancedSettings. |
getAdvancedSettingsBuilder()
public AdvancedSettings.Builder getAdvancedSettingsBuilder()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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
AdvancedSettingsOrBuilder |
|
getConditionalCases(int index)
public 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 |
|
getConditionalCasesBuilder(int index)
public Fulfillment.ConditionalCases.Builder getConditionalCasesBuilder(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.Builder |
|
getConditionalCasesBuilderList()
public List<Fulfillment.ConditionalCases.Builder> getConditionalCasesBuilderList()Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getConditionalCasesCount()
public int getConditionalCasesCount()Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Returns | |
|---|---|
| Type | Description |
int |
|
getConditionalCasesList()
public 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 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 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> |
|
getDefaultInstanceForType()
public Fulfillment getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Fulfillment |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 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 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 |
|
getMessagesBuilder(int index)
public ResponseMessage.Builder getMessagesBuilder(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.Builder |
|
getMessagesBuilderList()
public List<ResponseMessage.Builder> getMessagesBuilderList()The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getMessagesCount()
public 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 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 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 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 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 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 |
|
getSetParameterActionsBuilder(int index)
public Fulfillment.SetParameterAction.Builder getSetParameterActionsBuilder(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.Builder |
|
getSetParameterActionsBuilderList()
public List<Fulfillment.SetParameterAction.Builder> getSetParameterActionsBuilderList()Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getSetParameterActionsCount()
public 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 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 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 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 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 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 String getWebhook() The webhook to call.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
string webhook = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The webhook. |
getWebhookBytes()
public ByteString getWebhookBytes() The webhook to call.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
string webhook = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for webhook. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSettings field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdvancedSettings(AdvancedSettings value)
public Fulfillment.Builder mergeAdvancedSettings(AdvancedSettings value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
mergeFrom(Fulfillment other)
public Fulfillment.Builder mergeFrom(Fulfillment other)| Parameter | |
|---|---|
| Name | Description |
other |
Fulfillment |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Fulfillment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Fulfillment.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Fulfillment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
removeConditionalCases(int index)
public Fulfillment.Builder removeConditionalCases(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.Builder |
|
removeMessages(int index)
public Fulfillment.Builder removeMessages(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 |
Fulfillment.Builder |
|
removeSetParameterActions(int index)
public Fulfillment.Builder removeSetParameterActions(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.Builder |
|
setAdvancedSettings(AdvancedSettings value)
public Fulfillment.Builder setAdvancedSettings(AdvancedSettings value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSettings |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setAdvancedSettings(AdvancedSettings.Builder builderForValue)
public Fulfillment.Builder setAdvancedSettings(AdvancedSettings.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AdvancedSettings.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setConditionalCases(int index, Fulfillment.ConditionalCases value)
public Fulfillment.Builder setConditionalCases(int index, Fulfillment.ConditionalCases value)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Fulfillment.ConditionalCases |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setConditionalCases(int index, Fulfillment.ConditionalCases.Builder builderForValue)
public Fulfillment.Builder setConditionalCases(int index, Fulfillment.ConditionalCases.Builder builderForValue)Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.ConditionalCases conditional_cases = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Fulfillment.ConditionalCases.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setEnableGenerativeFallback(boolean value)
public Fulfillment.Builder setEnableGenerativeFallback(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableGenerativeFallback to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Fulfillment.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setMessages(int index, ResponseMessage value)
public Fulfillment.Builder setMessages(int index, ResponseMessage value)The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ResponseMessage |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setMessages(int index, ResponseMessage.Builder builderForValue)
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.v3beta1.ResponseMessage messages = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ResponseMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Fulfillment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setReturnPartialResponses(boolean value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe returnPartialResponses to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
setSetParameterActions(int index, Fulfillment.SetParameterAction value)
public Fulfillment.Builder setSetParameterActions(int index, Fulfillment.SetParameterAction value)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Fulfillment.SetParameterAction |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setSetParameterActions(int index, Fulfillment.SetParameterAction.Builder builderForValue)
public Fulfillment.Builder setSetParameterActions(int index, Fulfillment.SetParameterAction.Builder builderForValue)Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Fulfillment.SetParameterAction.Builder |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setTag(String value)
public Fulfillment.Builder setTag(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe tag to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
setTagBytes(ByteString value)
public Fulfillment.Builder setTagBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for tag to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Fulfillment.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
|
setWebhook(String value)
public Fulfillment.Builder setWebhook(String value) The webhook to call.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
string webhook = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe webhook to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |
setWebhookBytes(ByteString value)
public Fulfillment.Builder setWebhookBytes(ByteString value) The webhook to call.
Format:
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>.
string webhook = 2 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for webhook to set. |
| Returns | |
|---|---|
| Type | Description |
Fulfillment.Builder |
This builder for chaining. |