Class ResponseMessage.LiveAgentHandoff.Builder (4.38.0)

public static final class ResponseMessage.LiveAgentHandoff.Builder extends GeneratedMessageV3.Builder<ResponseMessage.LiveAgentHandoff.Builder> implements ResponseMessage.LiveAgentHandoffOrBuilder

Indicates that the conversation should be handed off to a human 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 CX 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.v2beta1.ResponseMessage.LiveAgentHandoff

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResponseMessage.LiveAgentHandoff.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ResponseMessage.LiveAgentHandoff.Builder clear()
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ResponseMessage.LiveAgentHandoff.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

clearMetadata()

public ResponseMessage.LiveAgentHandoff.Builder clearMetadata()

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

.google.protobuf.Struct metadata = 1;

Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ResponseMessage.LiveAgentHandoff.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

clone()

public ResponseMessage.LiveAgentHandoff.Builder clone()
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getMetadataBuilder()

public Struct.Builder getMetadataBuilder()

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

.google.protobuf.Struct metadata = 1;

Returns
Type Description
Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ResponseMessage.LiveAgentHandoff other)

public ResponseMessage.LiveAgentHandoff.Builder mergeFrom(ResponseMessage.LiveAgentHandoff other)
Parameter
Name Description
other ResponseMessage.LiveAgentHandoff
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResponseMessage.LiveAgentHandoff.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ResponseMessage.LiveAgentHandoff.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

mergeMetadata(Struct value)

public ResponseMessage.LiveAgentHandoff.Builder mergeMetadata(Struct value)

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

.google.protobuf.Struct metadata = 1;

Parameter
Name Description
value Struct
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMessage.LiveAgentHandoff.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ResponseMessage.LiveAgentHandoff.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

setMetadata(Struct value)

public ResponseMessage.LiveAgentHandoff.Builder setMetadata(Struct value)

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

.google.protobuf.Struct metadata = 1;

Parameter
Name Description
value Struct
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

setMetadata(Struct.Builder builderForValue)

public ResponseMessage.LiveAgentHandoff.Builder setMetadata(Struct.Builder builderForValue)

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

.google.protobuf.Struct metadata = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder

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

public ResponseMessage.LiveAgentHandoff.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMessage.LiveAgentHandoff.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ResponseMessage.LiveAgentHandoff.Builder
Overrides