Class WebhookResponse.Builder (4.4.0)

Version 4.4.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static final class WebhookResponse.Builder extends GeneratedMessageV3.Builder<WebhookResponse.Builder> implements WebhookResponseOrBuilder

The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:

• Use "" for empty strings
• Use {} or null for empty objects
• Use [] or null for empty arrays For more information, see the Protocol Buffers Language Guide.

Protobuf type google.cloud.dialogflow.v2.WebhookResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WebhookResponse.Builder

Implements

WebhookResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addAllFulfillmentMessages(Iterable<? extends Intent.Message> values)

public WebhookResponse.Builder addAllFulfillmentMessages(Iterable<? extends Intent.Message> values)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.dialogflow.v2.Intent.Message>

Returns

Type	Description
WebhookResponse.Builder

addAllOutputContexts(Iterable<? extends Context> values)

public WebhookResponse.Builder addAllOutputContexts(Iterable<? extends Context> values)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.dialogflow.v2.Context>

Returns

Type	Description
WebhookResponse.Builder

addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

public WebhookResponse.Builder addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
values	Iterable<? extends com.google.cloud.dialogflow.v2.SessionEntityType>

Returns

Type	Description
WebhookResponse.Builder

addFulfillmentMessages(Intent.Message value)

public WebhookResponse.Builder addFulfillmentMessages(Intent.Message value)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
value	Intent.Message

Returns

Type	Description
WebhookResponse.Builder

addFulfillmentMessages(Intent.Message.Builder builderForValue)

public WebhookResponse.Builder addFulfillmentMessages(Intent.Message.Builder builderForValue)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
builderForValue	Intent.Message.Builder

Returns

Type	Description
WebhookResponse.Builder

addFulfillmentMessages(int index, Intent.Message value)

public WebhookResponse.Builder addFulfillmentMessages(int index, Intent.Message value)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameters

Name	Description
index	int
value	Intent.Message

Returns

Type	Description
WebhookResponse.Builder

addFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

public WebhookResponse.Builder addFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameters

Name	Description
index	int
builderForValue	Intent.Message.Builder

Returns

Type	Description
WebhookResponse.Builder

addFulfillmentMessagesBuilder()

public Intent.Message.Builder addFulfillmentMessagesBuilder()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
Intent.Message.Builder

addFulfillmentMessagesBuilder(int index)

public Intent.Message.Builder addFulfillmentMessagesBuilder(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
Intent.Message.Builder

addOutputContexts(Context value)

public WebhookResponse.Builder addOutputContexts(Context value)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
value	Context

Returns

Type	Description
WebhookResponse.Builder

addOutputContexts(Context.Builder builderForValue)

public WebhookResponse.Builder addOutputContexts(Context.Builder builderForValue)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
builderForValue	Context.Builder

Returns

Type	Description
WebhookResponse.Builder

addOutputContexts(int index, Context value)

public WebhookResponse.Builder addOutputContexts(int index, Context value)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameters

Name	Description
index	int
value	Context

Returns

Type	Description
WebhookResponse.Builder

addOutputContexts(int index, Context.Builder builderForValue)

public WebhookResponse.Builder addOutputContexts(int index, Context.Builder builderForValue)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameters

Name	Description
index	int
builderForValue	Context.Builder

Returns

Type	Description
WebhookResponse.Builder

addOutputContextsBuilder()

public Context.Builder addOutputContextsBuilder()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
Context.Builder

addOutputContextsBuilder(int index)

public Context.Builder addOutputContextsBuilder(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
Context.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WebhookResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSessionEntityTypes(SessionEntityType value)

public WebhookResponse.Builder addSessionEntityTypes(SessionEntityType value)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
value	SessionEntityType

Returns

Type	Description
WebhookResponse.Builder

addSessionEntityTypes(SessionEntityType.Builder builderForValue)

public WebhookResponse.Builder addSessionEntityTypes(SessionEntityType.Builder builderForValue)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
builderForValue	SessionEntityType.Builder

Returns

Type	Description
WebhookResponse.Builder

addSessionEntityTypes(int index, SessionEntityType value)

public WebhookResponse.Builder addSessionEntityTypes(int index, SessionEntityType value)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameters

Name	Description
index	int
value	SessionEntityType

Returns

Type	Description
WebhookResponse.Builder

addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public WebhookResponse.Builder addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameters

Name	Description
index	int
builderForValue	SessionEntityType.Builder

Returns

Type	Description
WebhookResponse.Builder

addSessionEntityTypesBuilder()

public SessionEntityType.Builder addSessionEntityTypesBuilder()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
SessionEntityType.Builder

addSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder addSessionEntityTypesBuilder(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
SessionEntityType.Builder

build()

public WebhookResponse build()

Returns

Type	Description
WebhookResponse

buildPartial()

public WebhookResponse buildPartial()

Returns

Type	Description
WebhookResponse

clear()

public WebhookResponse.Builder clear()

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public WebhookResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFollowupEventInput()

public WebhookResponse.Builder clearFollowupEventInput()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Returns

Type	Description
WebhookResponse.Builder

clearFulfillmentMessages()

public WebhookResponse.Builder clearFulfillmentMessages()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
WebhookResponse.Builder

clearFulfillmentText()

public WebhookResponse.Builder clearFulfillmentText()

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WebhookResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputContexts()

public WebhookResponse.Builder clearOutputContexts()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
WebhookResponse.Builder

clearPayload()

public WebhookResponse.Builder clearPayload()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns

Type	Description
WebhookResponse.Builder

clearSessionEntityTypes()

public WebhookResponse.Builder clearSessionEntityTypes()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
WebhookResponse.Builder

clearSource()

public WebhookResponse.Builder clearSource()

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

clone()

public WebhookResponse.Builder clone()

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public WebhookResponse getDefaultInstanceForType()

Returns

Type	Description
WebhookResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFollowupEventInput()

public EventInput getFollowupEventInput()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Returns

Type	Description
EventInput	The followupEventInput.

getFollowupEventInputBuilder()

public EventInput.Builder getFollowupEventInputBuilder()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Returns

Type	Description
EventInput.Builder

getFollowupEventInputOrBuilder()

public EventInputOrBuilder getFollowupEventInputOrBuilder()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Returns

Type	Description
EventInputOrBuilder

getFulfillmentMessages(int index)

public Intent.Message getFulfillmentMessages(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
Intent.Message

getFulfillmentMessagesBuilder(int index)

public Intent.Message.Builder getFulfillmentMessagesBuilder(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
Intent.Message.Builder

getFulfillmentMessagesBuilderList()

public List<Intent.Message.Builder> getFulfillmentMessagesBuilderList()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
List<Builder>

getFulfillmentMessagesCount()

public int getFulfillmentMessagesCount()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
int

getFulfillmentMessagesList()

public List<Intent.Message> getFulfillmentMessagesList()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
List<Message>

getFulfillmentMessagesOrBuilder(int index)

public Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
Intent.MessageOrBuilder

getFulfillmentMessagesOrBuilderList()

public List<? extends Intent.MessageOrBuilder> getFulfillmentMessagesOrBuilderList()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder>

getFulfillmentText()

public String getFulfillmentText()

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Returns

Type	Description
String	The fulfillmentText.

getFulfillmentTextBytes()

public ByteString getFulfillmentTextBytes()

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Returns

Type	Description
ByteString	The bytes for fulfillmentText.

getOutputContexts(int index)

public Context getOutputContexts(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
Context

getOutputContextsBuilder(int index)

public Context.Builder getOutputContextsBuilder(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
Context.Builder

getOutputContextsBuilderList()

public List<Context.Builder> getOutputContextsBuilderList()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
List<Builder>

getOutputContextsCount()

public int getOutputContextsCount()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
int

getOutputContextsList()

public List<Context> getOutputContextsList()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
List<Context>

getOutputContextsOrBuilder(int index)

public ContextOrBuilder getOutputContextsOrBuilder(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
ContextOrBuilder

getOutputContextsOrBuilderList()

public List<? extends ContextOrBuilder> getOutputContextsOrBuilderList()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2.ContextOrBuilder>

getPayload()

public Struct getPayload()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns

Type	Description
Struct	The payload.

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns

Type	Description
Builder

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns

Type	Description
StructOrBuilder

getSessionEntityTypes(int index)

public SessionEntityType getSessionEntityTypes(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
SessionEntityType

getSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder getSessionEntityTypesBuilder(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
SessionEntityType.Builder

getSessionEntityTypesBuilderList()

public List<SessionEntityType.Builder> getSessionEntityTypesBuilderList()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
List<Builder>

getSessionEntityTypesCount()

public int getSessionEntityTypesCount()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
int

getSessionEntityTypesList()

public List<SessionEntityType> getSessionEntityTypesList()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
List<SessionEntityType>

getSessionEntityTypesOrBuilder(int index)

public SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
SessionEntityTypeOrBuilder

getSessionEntityTypesOrBuilderList()

public List<? extends SessionEntityTypeOrBuilder> getSessionEntityTypesOrBuilderList()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2.SessionEntityTypeOrBuilder>

getSource()

public String getSource()

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Returns

Type	Description
String	The source.

getSourceBytes()

public ByteString getSourceBytes()

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Returns

Type	Description
ByteString	The bytes for source.

hasFollowupEventInput()

public boolean hasFollowupEventInput()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Returns

Type	Description
boolean	Whether the followupEventInput field is set.

hasPayload()

public boolean hasPayload()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns

Type	Description
boolean	Whether the payload field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFollowupEventInput(EventInput value)

public WebhookResponse.Builder mergeFollowupEventInput(EventInput value)

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Parameter

Name	Description
value	EventInput

Returns

Type	Description
WebhookResponse.Builder

mergeFrom(WebhookResponse other)

public WebhookResponse.Builder mergeFrom(WebhookResponse other)

Parameter

Name	Description
other	WebhookResponse

Returns

Type	Description
WebhookResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WebhookResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
WebhookResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public WebhookResponse.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
WebhookResponse.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergePayload(Struct value)

public WebhookResponse.Builder mergePayload(Struct value)

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Parameter

Name	Description
value	Struct

Returns

Type	Description
WebhookResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WebhookResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFulfillmentMessages(int index)

public WebhookResponse.Builder removeFulfillmentMessages(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameter

Name	Description
index	int

Returns

Type	Description
WebhookResponse.Builder

removeOutputContexts(int index)

public WebhookResponse.Builder removeOutputContexts(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
WebhookResponse.Builder

removeSessionEntityTypes(int index)

public WebhookResponse.Builder removeSessionEntityTypes(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
WebhookResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WebhookResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFollowupEventInput(EventInput value)

public WebhookResponse.Builder setFollowupEventInput(EventInput value)

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Parameter

Name	Description
value	EventInput

Returns

Type	Description
WebhookResponse.Builder

setFollowupEventInput(EventInput.Builder builderForValue)

public WebhookResponse.Builder setFollowupEventInput(EventInput.Builder builderForValue)

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2.EventInput followup_event_input = 6;

Parameter

Name	Description
builderForValue	EventInput.Builder

Returns

Type	Description
WebhookResponse.Builder

setFulfillmentMessages(int index, Intent.Message value)

public WebhookResponse.Builder setFulfillmentMessages(int index, Intent.Message value)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameters

Name	Description
index	int
value	Intent.Message

Returns

Type	Description
WebhookResponse.Builder

setFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

public WebhookResponse.Builder setFulfillmentMessages(int index, Intent.Message.Builder builderForValue)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;

Parameters

Name	Description
index	int
builderForValue	Intent.Message.Builder

Returns

Type	Description
WebhookResponse.Builder

setFulfillmentText(String value)

public WebhookResponse.Builder setFulfillmentText(String value)

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Parameter

Name	Description
value	String The fulfillmentText to set.

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

setFulfillmentTextBytes(ByteString value)

public WebhookResponse.Builder setFulfillmentTextBytes(ByteString value)

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Parameter

Name	Description
value	ByteString The bytes for fulfillmentText to set.

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

setOutputContexts(int index, Context value)

public WebhookResponse.Builder setOutputContexts(int index, Context value)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameters

Name	Description
index	int
value	Context

Returns

Type	Description
WebhookResponse.Builder

setOutputContexts(int index, Context.Builder builderForValue)

public WebhookResponse.Builder setOutputContexts(int index, Context.Builder builderForValue)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;

Parameters

Name	Description
index	int
builderForValue	Context.Builder

Returns

Type	Description
WebhookResponse.Builder

setPayload(Struct value)

public WebhookResponse.Builder setPayload(Struct value)

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Parameter

Name	Description
value	Struct

Returns

Type	Description
WebhookResponse.Builder

setPayload(Struct.Builder builderForValue)

public WebhookResponse.Builder setPayload(Struct.Builder builderForValue)

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
WebhookResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WebhookResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSessionEntityTypes(int index, SessionEntityType value)

public WebhookResponse.Builder setSessionEntityTypes(int index, SessionEntityType value)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameters

Name	Description
index	int
value	SessionEntityType

Returns

Type	Description
WebhookResponse.Builder

setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public WebhookResponse.Builder setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;

Parameters

Name	Description
index	int
builderForValue	SessionEntityType.Builder

Returns

Type	Description
WebhookResponse.Builder

setSource(String value)

public WebhookResponse.Builder setSource(String value)

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Parameter

Name	Description
value	String The source to set.

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

setSourceBytes(ByteString value)

public WebhookResponse.Builder setSourceBytes(ByteString value)

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Parameter

Name	Description
value	ByteString The bytes for source to set.

Returns

Type	Description
WebhookResponse.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WebhookResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
WebhookResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)