public final class Fulfillment extends GeneratedMessageV3 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 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.v3.Fulfillment
Static Fields
CONDITIONAL_CASES_FIELD_NUMBER
public static final int CONDITIONAL_CASES_FIELD_NUMBER
Field Value
MESSAGES_FIELD_NUMBER
public static final int MESSAGES_FIELD_NUMBER
Field Value
RETURN_PARTIAL_RESPONSES_FIELD_NUMBER
public static final int RETURN_PARTIAL_RESPONSES_FIELD_NUMBER
Field Value
SET_PARAMETER_ACTIONS_FIELD_NUMBER
public static final int SET_PARAMETER_ACTIONS_FIELD_NUMBER
Field Value
TAG_FIELD_NUMBER
public static final int TAG_FIELD_NUMBER
Field Value
WEBHOOK_FIELD_NUMBER
public static final int WEBHOOK_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Fulfillment getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Fulfillment.Builder newBuilder()
Returns
newBuilder(Fulfillment prototype)
public static Fulfillment.Builder newBuilder(Fulfillment prototype)
Parameter
Returns
public static Fulfillment parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Fulfillment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Fulfillment parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Fulfillment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Fulfillment parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Fulfillment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Fulfillment parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Fulfillment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Fulfillment parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Fulfillment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Fulfillment parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Fulfillment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Fulfillment> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConditionalCases(int index)
public Fulfillment.ConditionalCases getConditionalCases(int index)
Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
getConditionalCasesCount()
public int getConditionalCasesCount()
Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
getConditionalCasesList()
public List<Fulfillment.ConditionalCases> getConditionalCasesList()
Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
getConditionalCasesOrBuilder(int index)
public Fulfillment.ConditionalCasesOrBuilder getConditionalCasesOrBuilder(int index)
Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
getConditionalCasesOrBuilderList()
public List<? extends Fulfillment.ConditionalCasesOrBuilder> getConditionalCasesOrBuilderList()
Conditional cases for this fulfillment.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
| Type | Description |
| List<? extends com.google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCasesOrBuilder> | |
getDefaultInstanceForType()
public Fulfillment getDefaultInstanceForType()
Returns
getMessages(int index)
public 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()
public int getMessagesCount()
The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
getMessagesList()
public List<ResponseMessage> getMessagesList()
The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
getMessagesOrBuilder(int index)
public ResponseMessageOrBuilder getMessagesOrBuilder(int index)
The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
getMessagesOrBuilderList()
public List<? extends ResponseMessageOrBuilder> getMessagesOrBuilderList()
The list of rich message responses to present to the user.
repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
| Type | Description |
| List<? extends com.google.cloud.dialogflow.cx.v3.ResponseMessageOrBuilder> | |
getParserForType()
public Parser<Fulfillment> getParserForType()
Returns
Overrides
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;
| Type | Description |
| boolean | The returnPartialResponses.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSetParameterActions(int index)
public 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()
public int getSetParameterActionsCount()
Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
getSetParameterActionsList()
public List<Fulfillment.SetParameterAction> getSetParameterActionsList()
Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
getSetParameterActionsOrBuilder(int index)
public Fulfillment.SetParameterActionOrBuilder getSetParameterActionsOrBuilder(int index)
Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
getSetParameterActionsOrBuilderList()
public List<? extends Fulfillment.SetParameterActionOrBuilder> getSetParameterActionsOrBuilderList()
Set parameter values before executing the webhook.
repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
| Type | Description |
| List<? extends com.google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterActionOrBuilder> | |
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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWebhook()
public 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) = { ... }
| Type | Description |
| String | The webhook.
|
getWebhookBytes()
public 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) = { ... }
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Fulfillment.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Fulfillment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Fulfillment.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
