Class WebhookResponse (0.54.0)

public final class WebhookResponse extends GeneratedMessageV3 implements WebhookResponseOrBuilder

The response message for a webhook call.

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

Inheritance

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

Implements

WebhookResponseOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FULFILLMENT_RESPONSE_FIELD_NUMBER

public static final int FULFILLMENT_RESPONSE_FIELD_NUMBER

Field Value
Type	Description
`int`

PAGE_INFO_FIELD_NUMBER

public static final int PAGE_INFO_FIELD_NUMBER

Field Value
Type	Description
`int`

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER

Field Value
Type	Description
`int`

SESSION_INFO_FIELD_NUMBER

public static final int SESSION_INFO_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_FLOW_FIELD_NUMBER

public static final int TARGET_FLOW_FIELD_NUMBER

Field Value
Type	Description
`int`

TARGET_PAGE_FIELD_NUMBER

public static final int TARGET_PAGE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static WebhookResponse getDefaultInstance()

Returns
Type	Description
`WebhookResponse`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static WebhookResponse.Builder newBuilder()

Returns
Type	Description
`WebhookResponse.Builder`

newBuilder(WebhookResponse prototype)

public static WebhookResponse.Builder newBuilder(WebhookResponse prototype)

Parameter
Name	Description
`prototype`	`WebhookResponse`

Returns
Type	Description
`WebhookResponse.Builder`

parseDelimitedFrom(InputStream input)

public static WebhookResponse parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static WebhookResponse parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static WebhookResponse parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static WebhookResponse parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static WebhookResponse parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static WebhookResponse parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WebhookResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`WebhookResponse`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<WebhookResponse> parser()

Returns
Type	Description
`Parser<WebhookResponse>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public WebhookResponse getDefaultInstanceForType()

Returns
Type	Description
`WebhookResponse`

getFulfillmentResponse()

public WebhookResponse.FulfillmentResponse getFulfillmentResponse()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type	Description
`WebhookResponse.FulfillmentResponse`	The fulfillmentResponse.

getFulfillmentResponseOrBuilder()

public WebhookResponse.FulfillmentResponseOrBuilder getFulfillmentResponseOrBuilder()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type	Description
`WebhookResponse.FulfillmentResponseOrBuilder`

getPageInfo()

public PageInfo getPageInfo()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 2;

Returns
Type	Description
`PageInfo`	The pageInfo.

getPageInfoOrBuilder()

public PageInfoOrBuilder getPageInfoOrBuilder()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 2;

Returns
Type	Description
`PageInfoOrBuilder`

getParserForType()

public Parser<WebhookResponse> getParserForType()

Returns
Type	Description
`Parser<WebhookResponse>`

Overrides

GeneratedMessageV3.getParserForType()

getPayload()

public Struct getPayload()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`Struct`	The payload.

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`StructOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSessionInfo()

public SessionInfo getSessionInfo()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 3;

Returns
Type	Description
`SessionInfo`	The sessionInfo.

getSessionInfoOrBuilder()

public SessionInfoOrBuilder getSessionInfoOrBuilder()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 3;

Returns
Type	Description
`SessionInfoOrBuilder`

getTargetFlow()

public String getTargetFlow()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The targetFlow.

getTargetFlowBytes()

public ByteString getTargetFlowBytes()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for targetFlow.

getTargetPage()

public String getTargetPage()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The targetPage.

getTargetPageBytes()

public ByteString getTargetPageBytes()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for targetPage.

getTransitionCase()

public WebhookResponse.TransitionCase getTransitionCase()

Returns
Type	Description
`WebhookResponse.TransitionCase`

hasFulfillmentResponse()

public boolean hasFulfillmentResponse()

The fulfillment response to send to the user. This field can be omitted by the webhook if it does not intend to send any response to the user.

.google.cloud.dialogflow.cx.v3.WebhookResponse.FulfillmentResponse fulfillment_response = 1;

Returns
Type	Description
`boolean`	Whether the fulfillmentResponse field is set.

hasPageInfo()

public boolean hasPageInfo()

Information about page status. This field can be omitted by the webhook if it does not intend to modify page status.

.google.cloud.dialogflow.cx.v3.PageInfo page_info = 2;

Returns
Type	Description
`boolean`	Whether the pageInfo field is set.

hasPayload()

public boolean hasPayload()

Value to append directly to QueryResult.webhook_payloads.

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`boolean`	Whether the payload field is set.

hasSessionInfo()

public boolean hasSessionInfo()

Information about session status. This field can be omitted by the webhook if it does not intend to modify session status.

.google.cloud.dialogflow.cx.v3.SessionInfo session_info = 3;

Returns
Type	Description
`boolean`	Whether the sessionInfo field is set.

hasTargetFlow()

public boolean hasTargetFlow()

The target flow to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>.

string target_flow = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the targetFlow field is set.

hasTargetPage()

public boolean hasTargetPage()

The target page to transition to. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string target_page = 5 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the targetPage field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public WebhookResponse.Builder newBuilderForType()

Returns
Type	Description
`WebhookResponse.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WebhookResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`WebhookResponse.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public WebhookResponse.Builder toBuilder()

Returns
Type	Description
`WebhookResponse.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`