public final class WebhookResponse extends GeneratedMessageV3 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][google.cloud.dialogflow.v2.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](https://developers.google.com/protocol-buffers/docs/proto3#json).
Protobuf type google.cloud.dialogflow.v2.WebhookResponse| Modifier and Type | Class and Description |
|---|---|
static class |
WebhookResponse.Builder
The response message for a webhook call.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
FOLLOWUP_EVENT_INPUT_FIELD_NUMBER |
static int |
FULFILLMENT_MESSAGES_FIELD_NUMBER |
static int |
FULFILLMENT_TEXT_FIELD_NUMBER |
static int |
OUTPUT_CONTEXTS_FIELD_NUMBER |
static int |
PAYLOAD_FIELD_NUMBER |
static int |
SESSION_ENTITY_TYPES_FIELD_NUMBER |
static int |
SOURCE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int FULFILLMENT_TEXT_FIELD_NUMBER
public static final int FULFILLMENT_MESSAGES_FIELD_NUMBER
public static final int SOURCE_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
public static final int OUTPUT_CONTEXTS_FIELD_NUMBER
public static final int FOLLOWUP_EVENT_INPUT_FIELD_NUMBER
public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_text] sent to the integration or API caller.
string fulfillment_text = 1;getFulfillmentText in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_text] sent to the integration or API caller.
string fulfillment_text = 1;getFulfillmentTextBytes in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;getFulfillmentMessagesList in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;getFulfillmentMessagesOrBuilderList in interface WebhookResponseOrBuilderpublic int getFulfillmentMessagesCount()
Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate [QueryResult.fulfillment_messages][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;getFulfillmentMessagesCount in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;getFulfillmentMessages in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;getFulfillmentMessagesOrBuilder in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.webhook_source] sent to the integration or API caller.
string source = 3;getSource in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.webhook_source] sent to the integration or API caller.
string source = 3;getSourceBytes in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.webhook_payload] sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
.google.protobuf.Struct payload = 4;hasPayload in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.webhook_payload] sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
.google.protobuf.Struct payload = 4;getPayload in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.webhook_payload] sent to the integration or API caller. This field is also used by the [Google Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/aog) for rich response messages. See the format definition at [Google Assistant Dialogflow webhook format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
.google.protobuf.Struct payload = 4;getPayloadOrBuilder in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.output_contexts] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;getOutputContextsList in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.output_contexts] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;getOutputContextsOrBuilderList in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.output_contexts] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;getOutputContextsCount in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.output_contexts] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;getOutputContexts in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.QueryResult.output_contexts] sent to the integration or API caller.
repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;getOutputContextsOrBuilder in interface WebhookResponseOrBuilderpublic 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;hasFollowupEventInput in interface WebhookResponseOrBuilderpublic 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;getFollowupEventInput in interface WebhookResponseOrBuilderpublic 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;getFollowupEventInputOrBuilder in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.SessionEntityType] management methods.
repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;getSessionEntityTypesList in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.SessionEntityType] management methods.
repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;getSessionEntityTypesOrBuilderList in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.SessionEntityType] management methods.
repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;getSessionEntityTypesCount in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.SessionEntityType] management methods.
repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;getSessionEntityTypes in interface WebhookResponseOrBuilderpublic 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][google.cloud.dialogflow.v2.SessionEntityType] management methods.
repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;getSessionEntityTypesOrBuilder in interface WebhookResponseOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static WebhookResponse parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static WebhookResponse parseFrom(InputStream input) throws IOException
IOExceptionpublic static WebhookResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static WebhookResponse parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static WebhookResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static WebhookResponse parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static WebhookResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic WebhookResponse.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static WebhookResponse.Builder newBuilder()
public static WebhookResponse.Builder newBuilder(WebhookResponse prototype)
public WebhookResponse.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected WebhookResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static WebhookResponse getDefaultInstance()
public static Parser<WebhookResponse> parser()
public Parser<WebhookResponse> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public WebhookResponse getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.