Class ResponseMessage (4.33.0)

public final class ResponseMessage extends GeneratedMessageV3 implements ResponseMessageOrBuilder

Response messages from an automated agent.

Protobuf type google.cloud.dialogflow.v2beta1.ResponseMessage

Static Fields

END_INTERACTION_FIELD_NUMBER

public static final int END_INTERACTION_FIELD_NUMBER
Field Value
Type Description
int

LIVE_AGENT_HANDOFF_FIELD_NUMBER

public static final int LIVE_AGENT_HANDOFF_FIELD_NUMBER
Field Value
Type Description
int

MIXED_AUDIO_FIELD_NUMBER

public static final int MIXED_AUDIO_FIELD_NUMBER
Field Value
Type Description
int

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

TELEPHONY_TRANSFER_CALL_FIELD_NUMBER

public static final int TELEPHONY_TRANSFER_CALL_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ResponseMessage getDefaultInstance()
Returns
Type Description
ResponseMessage

getDescriptor()

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

newBuilder()

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

newBuilder(ResponseMessage prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ResponseMessage getDefaultInstanceForType()
Returns
Type Description
ResponseMessage

getEndInteraction()

public ResponseMessage.EndInteraction getEndInteraction()

A signal that indicates the interaction with the Dialogflow agent has ended.

.google.cloud.dialogflow.v2beta1.ResponseMessage.EndInteraction end_interaction = 4;

Returns
Type Description
ResponseMessage.EndInteraction

The endInteraction.

getEndInteractionOrBuilder()

public ResponseMessage.EndInteractionOrBuilder getEndInteractionOrBuilder()

A signal that indicates the interaction with the Dialogflow agent has ended.

.google.cloud.dialogflow.v2beta1.ResponseMessage.EndInteraction end_interaction = 4;

Returns
Type Description
ResponseMessage.EndInteractionOrBuilder

getLiveAgentHandoff()

public ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()

Hands off conversation to a live agent.

.google.cloud.dialogflow.v2beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 3;

Returns
Type Description
ResponseMessage.LiveAgentHandoff

The liveAgentHandoff.

getLiveAgentHandoffOrBuilder()

public ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()

Hands off conversation to a live agent.

.google.cloud.dialogflow.v2beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 3;

Returns
Type Description
ResponseMessage.LiveAgentHandoffOrBuilder

getMessageCase()

public ResponseMessage.MessageCase getMessageCase()
Returns
Type Description
ResponseMessage.MessageCase

getMixedAudio()

public ResponseMessage.MixedAudio getMixedAudio()

An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

.google.cloud.dialogflow.v2beta1.ResponseMessage.MixedAudio mixed_audio = 5;

Returns
Type Description
ResponseMessage.MixedAudio

The mixedAudio.

getMixedAudioOrBuilder()

public ResponseMessage.MixedAudioOrBuilder getMixedAudioOrBuilder()

An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

.google.cloud.dialogflow.v2beta1.ResponseMessage.MixedAudio mixed_audio = 5;

Returns
Type Description
ResponseMessage.MixedAudioOrBuilder

getParserForType()

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

getPayload()

public Struct getPayload()

Returns a response containing a custom, platform-specific payload.

.google.protobuf.Struct payload = 2;

Returns
Type Description
Struct

The payload.

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

Returns a response containing a custom, platform-specific payload.

.google.protobuf.Struct payload = 2;

Returns
Type Description
StructOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTelephonyTransferCall()

public ResponseMessage.TelephonyTransferCall getTelephonyTransferCall()

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

.google.cloud.dialogflow.v2beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 6;

Returns
Type Description
ResponseMessage.TelephonyTransferCall

The telephonyTransferCall.

getTelephonyTransferCallOrBuilder()

public ResponseMessage.TelephonyTransferCallOrBuilder getTelephonyTransferCallOrBuilder()

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

.google.cloud.dialogflow.v2beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 6;

Returns
Type Description
ResponseMessage.TelephonyTransferCallOrBuilder

getText()

public ResponseMessage.Text getText()

Returns a text response.

.google.cloud.dialogflow.v2beta1.ResponseMessage.Text text = 1;

Returns
Type Description
ResponseMessage.Text

The text.

getTextOrBuilder()

public ResponseMessage.TextOrBuilder getTextOrBuilder()

Returns a text response.

.google.cloud.dialogflow.v2beta1.ResponseMessage.Text text = 1;

Returns
Type Description
ResponseMessage.TextOrBuilder

hasEndInteraction()

public boolean hasEndInteraction()

A signal that indicates the interaction with the Dialogflow agent has ended.

.google.cloud.dialogflow.v2beta1.ResponseMessage.EndInteraction end_interaction = 4;

Returns
Type Description
boolean

Whether the endInteraction field is set.

hasLiveAgentHandoff()

public boolean hasLiveAgentHandoff()

Hands off conversation to a live agent.

.google.cloud.dialogflow.v2beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 3;

Returns
Type Description
boolean

Whether the liveAgentHandoff field is set.

hasMixedAudio()

public boolean hasMixedAudio()

An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client.

.google.cloud.dialogflow.v2beta1.ResponseMessage.MixedAudio mixed_audio = 5;

Returns
Type Description
boolean

Whether the mixedAudio field is set.

hasPayload()

public boolean hasPayload()

Returns a response containing a custom, platform-specific payload.

.google.protobuf.Struct payload = 2;

Returns
Type Description
boolean

Whether the payload field is set.

hasTelephonyTransferCall()

public boolean hasTelephonyTransferCall()

A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.

.google.cloud.dialogflow.v2beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 6;

Returns
Type Description
boolean

Whether the telephonyTransferCall field is set.

hasText()

public boolean hasText()

Returns a text response.

.google.cloud.dialogflow.v2beta1.ResponseMessage.Text text = 1;

Returns
Type Description
boolean

Whether the text 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.Builder newBuilderForType()
Returns
Type Description
ResponseMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ResponseMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ResponseMessage.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.Builder toBuilder()
Returns
Type Description
ResponseMessage.Builder

writeTo(CodedOutputStream output)

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