Class ResponseMessage.LiveAgentHandoff (0.66.0)

public static final class ResponseMessage.LiveAgentHandoff extends GeneratedMessageV3 implements ResponseMessage.LiveAgentHandoffOrBuilder

Indicates that the conversation should be handed off to a live agent.

Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures.

You may set this, for example:

  • In the entry_fulfillment of a Page if entering the page indicates something went extremely wrong in the conversation.
  • In a webhook response when you determine that the customer issue can only be handled by a human.

Protobuf type google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ResponseMessage.LiveAgentHandoff

Static Fields

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResponseMessage.LiveAgentHandoff getDefaultInstance()
Returns
Type Description
ResponseMessage.LiveAgentHandoff

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ResponseMessage.LiveAgentHandoff.Builder newBuilder()
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

newBuilder(ResponseMessage.LiveAgentHandoff prototype)

public static ResponseMessage.LiveAgentHandoff.Builder newBuilder(ResponseMessage.LiveAgentHandoff prototype)
Parameter
Name Description
prototype ResponseMessage.LiveAgentHandoff
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

parseDelimitedFrom(InputStream input)

public static ResponseMessage.LiveAgentHandoff parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ResponseMessage.LiveAgentHandoff parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ResponseMessage.LiveAgentHandoff parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ResponseMessage.LiveAgentHandoff parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ResponseMessage.LiveAgentHandoff parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ResponseMessage.LiveAgentHandoff parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ResponseMessage.LiveAgentHandoff parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ResponseMessage.LiveAgentHandoff> parser()
Returns
Type Description
Parser<LiveAgentHandoff>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ResponseMessage.LiveAgentHandoff getDefaultInstanceForType()
Returns
Type Description
ResponseMessage.LiveAgentHandoff

getMetadata()

public Struct getMetadata()

Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

.google.protobuf.Struct metadata = 1;

Returns
Type Description
Struct

The metadata.

getMetadataOrBuilder()

public StructOrBuilder getMetadataOrBuilder()

Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

.google.protobuf.Struct metadata = 1;

Returns
Type Description
StructOrBuilder

getParserForType()

public Parser<ResponseMessage.LiveAgentHandoff> getParserForType()
Returns
Type Description
Parser<LiveAgentHandoff>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMetadata()

public boolean hasMetadata()

Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.

.google.protobuf.Struct metadata = 1;

Returns
Type Description
boolean

Whether the metadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ResponseMessage.LiveAgentHandoff.Builder newBuilderForType()
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResponseMessage.LiveAgentHandoff.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ResponseMessage.LiveAgentHandoff.Builder toBuilder()
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException