- 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 WebhookResponseOrBuilderThe 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
{}ornullfor empty objects - Use
[]ornullfor empty arrays For more information, see the Protocol Buffers Language Guide.
Protobuf type google.cloud.dialogflow.v2beta1.WebhookResponse
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WebhookResponse.BuilderImplements
WebhookResponseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.v2beta1.Intent.Message> |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.v2beta1.Context> |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
values |
Iterable<? extends com.google.cloud.dialogflow.v2beta1.SessionEntityType> |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
value |
Intent.Message |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
builderForValue |
Intent.Message.Builder |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
value |
Intent.Message |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
builderForValue |
Intent.Message.Builder |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
value |
Context |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
builderForValue |
Context.Builder |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
value |
Context |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
builderForValue |
Context.Builder |
| 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.v2beta1.Context output_contexts = 5;
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
| Type | Description |
Context.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public WebhookResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
value |
SessionEntityType |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
builderForValue |
SessionEntityType.Builder |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
value |
SessionEntityType |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
builderForValue |
SessionEntityType.Builder |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
| Type | Description |
SessionEntityType.Builder |
build()
public WebhookResponse build()| Type | Description |
WebhookResponse |
buildPartial()
public WebhookResponse buildPartial()| Type | Description |
WebhookResponse |
clear()
public WebhookResponse.Builder clear()| Type | Description |
WebhookResponse.Builder |
clearEndInteraction()
public WebhookResponse.Builder clearEndInteraction()Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
bool end_interaction = 8;
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public WebhookResponse.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field |
FieldDescriptor |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.EventInput followup_event_input = 6;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| 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;
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
clearLiveAgentHandoff()
public WebhookResponse.Builder clearLiveAgentHandoff()Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
bool live_agent_handoff = 7;
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public WebhookResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof |
OneofDescriptor |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.Context output_contexts = 5;
| 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;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| 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;
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
clone()
public WebhookResponse.Builder clone()| Type | Description |
WebhookResponse.Builder |
getDefaultInstanceForType()
public WebhookResponse getDefaultInstanceForType()| Type | Description |
WebhookResponse |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
getEndInteraction()
public boolean getEndInteraction()Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
bool end_interaction = 8;
| Type | Description |
boolean |
The endInteraction. |
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.v2beta1.EventInput followup_event_input = 6;
| 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.v2beta1.EventInput followup_event_input = 6;
| 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.v2beta1.EventInput followup_event_input = 6;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Type | Description |
List<? extends com.google.cloud.dialogflow.v2beta1.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;
| 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;
| Type | Description |
ByteString |
The bytes for fulfillmentText. |
getLiveAgentHandoff()
public boolean getLiveAgentHandoff()Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
bool live_agent_handoff = 7;
| Type | Description |
boolean |
The liveAgentHandoff. |
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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
| 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.v2beta1.Context output_contexts = 5;
| 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.v2beta1.Context output_contexts = 5;
| 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.v2beta1.Context output_contexts = 5;
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
| 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.v2beta1.Context output_contexts = 5;
| Type | Description |
List<? extends com.google.cloud.dialogflow.v2beta1.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;
| 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;
| 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;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Type | Description |
List<? extends com.google.cloud.dialogflow.v2beta1.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;
| 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;
| 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.v2beta1.EventInput followup_event_input = 6;
| 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;
| Type | Description |
boolean |
Whether the payload field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
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.v2beta1.EventInput followup_event_input = 6;
| Name | Description |
value |
EventInput |
| Type | Description |
WebhookResponse.Builder |
mergeFrom(WebhookResponse other)
public WebhookResponse.Builder mergeFrom(WebhookResponse other)| Name | Description |
other |
WebhookResponse |
| Type | Description |
WebhookResponse.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public WebhookResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Type | Description |
WebhookResponse.Builder |
| Type | Description |
IOException |
mergeFrom(Message other)
public WebhookResponse.Builder mergeFrom(Message other)| Name | Description |
other |
Message |
| Type | Description |
WebhookResponse.Builder |
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;
| Name | Description |
value |
Struct |
| Type | Description |
WebhookResponse.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final WebhookResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields |
UnknownFieldSet |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
| Type | Description |
WebhookResponse.Builder |
setEndInteraction(boolean value)
public WebhookResponse.Builder setEndInteraction(boolean value)Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.
bool end_interaction = 8;
| Name | Description |
value |
booleanThe endInteraction to set. |
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public WebhookResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.EventInput followup_event_input = 6;
| Name | Description |
value |
EventInput |
| 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.v2beta1.EventInput followup_event_input = 6;
| Name | Description |
builderForValue |
EventInput.Builder |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
value |
Intent.Message |
| 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.v2beta1.Intent.Message fulfillment_messages = 2;
| Name | Description |
index |
int |
builderForValue |
Intent.Message.Builder |
| 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;
| Name | Description |
value |
StringThe fulfillmentText to set. |
| 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;
| Name | Description |
value |
ByteStringThe bytes for fulfillmentText to set. |
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
setLiveAgentHandoff(boolean value)
public WebhookResponse.Builder setLiveAgentHandoff(boolean value)Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.
bool live_agent_handoff = 7;
| Name | Description |
value |
booleanThe liveAgentHandoff to set. |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
value |
Context |
| 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.v2beta1.Context output_contexts = 5;
| Name | Description |
index |
int |
builderForValue |
Context.Builder |
| 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;
| Name | Description |
value |
Struct |
| 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;
| Name | Description |
builderForValue |
Builder |
| Type | Description |
WebhookResponse.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public WebhookResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Type | Description |
WebhookResponse.Builder |
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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
value |
SessionEntityType |
| 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.v2beta1.SessionEntityType session_entity_types = 10;
| Name | Description |
index |
int |
builderForValue |
SessionEntityType.Builder |
| 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;
| Name | Description |
value |
StringThe source to set. |
| 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;
| Name | Description |
value |
ByteStringThe bytes for source to set. |
| Type | Description |
WebhookResponse.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final WebhookResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields |
UnknownFieldSet |
| Type | Description |
WebhookResponse.Builder |