com.google.cloud.dialogflow.cx.v3

Class Fulfillment

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3.Fulfillment

All Implemented Interfaces:

FulfillmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Fulfillment
extends com.google.protobuf.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][google.cloud.dialogflow.cx.v3.Page] or
 [Form][google.cloud.dialogflow.cx.v3.Form] lifecycle. For example, when a [DetectIntentRequest][google.cloud.dialogflow.cx.v3.DetectIntentRequest] drives a
 session to enter a new page, the page's entry fulfillment can add a static
 response to the [QueryResult][google.cloud.dialogflow.cx.v3.QueryResult] in the returning [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse],
 call the webhook (for example, to load user data from a database), or both.
 

Protobuf type google.cloud.dialogflow.cx.v3.Fulfillment

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Fulfillment.Builder A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses.
static class	Fulfillment.ConditionalCases A list of cascading if-else conditions.
static interface	Fulfillment.ConditionalCasesOrBuilder
static class	Fulfillment.SetParameterAction Setting a parameter value.
static interface	Fulfillment.SetParameterActionOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONDITIONAL_CASES_FIELD_NUMBER
static int	MESSAGES_FIELD_NUMBER
static int	RETURN_PARTIAL_RESPONSES_FIELD_NUMBER
static int	SET_PARAMETER_ACTIONS_FIELD_NUMBER
static int	TAG_FIELD_NUMBER
static int	WEBHOOK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static Fulfillment	getDefaultInstance()
Fulfillment	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Fulfillment>	getParserForType()
boolean	getReturnPartialResponses() Whether Dialogflow should return currently queued fulfillment response messages in streaming APIs.
int	getSerializedSize()
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.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getWebhook() The webhook to call.
com.google.protobuf.ByteString	getWebhookBytes() The webhook to call.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Fulfillment.Builder	newBuilder()
static Fulfillment.Builder	newBuilder(Fulfillment prototype)
Fulfillment.Builder	newBuilderForType()
protected Fulfillment.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Fulfillment	parseDelimitedFrom(InputStream input)
static Fulfillment	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Fulfillment	parseFrom(byte[] data)
static Fulfillment	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Fulfillment	parseFrom(ByteBuffer data)
static Fulfillment	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Fulfillment	parseFrom(com.google.protobuf.ByteString data)
static Fulfillment	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Fulfillment	parseFrom(com.google.protobuf.CodedInputStream input)
static Fulfillment	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Fulfillment	parseFrom(InputStream input)
static Fulfillment	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Fulfillment>	parser()
Fulfillment.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MESSAGES_FIELD_NUMBER

public static final int MESSAGES_FIELD_NUMBER

See Also:

Constant Field Values

WEBHOOK_FIELD_NUMBER

public static final int WEBHOOK_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_PARTIAL_RESPONSES_FIELD_NUMBER

public static final int RETURN_PARTIAL_RESPONSES_FIELD_NUMBER

See Also:

Constant Field Values

TAG_FIELD_NUMBER

public static final int TAG_FIELD_NUMBER

See Also:

Constant Field Values

SET_PARAMETER_ACTIONS_FIELD_NUMBER

public static final int SET_PARAMETER_ACTIONS_FIELD_NUMBER

See Also:

Constant Field Values

CONDITIONAL_CASES_FIELD_NUMBER

public static final int CONDITIONAL_CASES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getMessagesList in interface FulfillmentOrBuilder

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;

Specified by:

getMessagesOrBuilderList in interface FulfillmentOrBuilder

getMessagesCount

public int getMessagesCount()

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

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

Specified by:

getMessagesCount in interface FulfillmentOrBuilder

getMessages

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;

Specified by:

getMessages in interface FulfillmentOrBuilder

getMessagesOrBuilder

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;

Specified by:

getMessagesOrBuilder in interface FulfillmentOrBuilder

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

Specified by:

getWebhook in interface FulfillmentOrBuilder

Returns:

The webhook.

getWebhookBytes

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

Specified by:

getWebhookBytes in interface FulfillmentOrBuilder

Returns:

The bytes for webhook.

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;

Specified by:

getReturnPartialResponses in interface FulfillmentOrBuilder

Returns:

The returnPartialResponses.

getTag

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

Specified by:

getTag in interface FulfillmentOrBuilder

Returns:

The tag.

getTagBytes

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

Specified by:

getTagBytes in interface FulfillmentOrBuilder

Returns:

The bytes for tag.

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;

Specified by:

getSetParameterActionsList in interface FulfillmentOrBuilder

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;

Specified by:

getSetParameterActionsOrBuilderList in interface FulfillmentOrBuilder

getSetParameterActionsCount

public int getSetParameterActionsCount()

 Set parameter values before executing the webhook.
 

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

Specified by:

getSetParameterActionsCount in interface FulfillmentOrBuilder

getSetParameterActions

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;

Specified by:

getSetParameterActions in interface FulfillmentOrBuilder

getSetParameterActionsOrBuilder

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;

Specified by:

getSetParameterActionsOrBuilder in interface FulfillmentOrBuilder

getConditionalCasesList

public List<Fulfillment.ConditionalCases> getConditionalCasesList()

 Conditional cases for this fulfillment.
 

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

Specified by:

getConditionalCasesList in interface FulfillmentOrBuilder

getConditionalCasesOrBuilderList

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

 Conditional cases for this fulfillment.
 

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

Specified by:

getConditionalCasesOrBuilderList in interface FulfillmentOrBuilder

getConditionalCasesCount

public int getConditionalCasesCount()

 Conditional cases for this fulfillment.
 

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

Specified by:

getConditionalCasesCount in interface FulfillmentOrBuilder

getConditionalCases

public Fulfillment.ConditionalCases getConditionalCases(int index)

 Conditional cases for this fulfillment.
 

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

Specified by:

getConditionalCases in interface FulfillmentOrBuilder

getConditionalCasesOrBuilder

public Fulfillment.ConditionalCasesOrBuilder getConditionalCasesOrBuilder(int index)

 Conditional cases for this fulfillment.
 

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

Specified by:

getConditionalCasesOrBuilder in interface FulfillmentOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Fulfillment parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Fulfillment parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Fulfillment parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Fulfillment parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Fulfillment parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static Fulfillment parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Fulfillment parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public Fulfillment.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Fulfillment.Builder newBuilder()

newBuilder

public static Fulfillment.Builder newBuilder(Fulfillment prototype)

toBuilder

public Fulfillment.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Fulfillment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Fulfillment getDefaultInstance()

parser

public static com.google.protobuf.Parser<Fulfillment> parser()

getParserForType

public com.google.protobuf.Parser<Fulfillment> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Fulfillment getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder