com.google.cloud.dialogflow.cx.v3

Interface ResponseMessageOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ResponseMessage, ResponseMessage.Builder

public interface ResponseMessageOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getChannel() The channel which the response is associated with.
com.google.protobuf.ByteString	getChannelBytes() The channel which the response is associated with.
ResponseMessage.ConversationSuccess	getConversationSuccess() Indicates that the conversation succeeded.
ResponseMessage.ConversationSuccessOrBuilder	getConversationSuccessOrBuilder() Indicates that the conversation succeeded.
ResponseMessage.EndInteraction	getEndInteraction() Output only.
ResponseMessage.EndInteractionOrBuilder	getEndInteractionOrBuilder() Output only.
ResponseMessage.KnowledgeInfoCard	getKnowledgeInfoCard() Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
ResponseMessage.KnowledgeInfoCardOrBuilder	getKnowledgeInfoCardOrBuilder() Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
ResponseMessage.LiveAgentHandoff	getLiveAgentHandoff() Hands off conversation to a human agent.
ResponseMessage.LiveAgentHandoffOrBuilder	getLiveAgentHandoffOrBuilder() Hands off conversation to a human agent.
ResponseMessage.MessageCase	getMessageCase()
ResponseMessage.MixedAudio	getMixedAudio() Output only.
ResponseMessage.MixedAudioOrBuilder	getMixedAudioOrBuilder() Output only.
ResponseMessage.OutputAudioText	getOutputAudioText() A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
ResponseMessage.OutputAudioTextOrBuilder	getOutputAudioTextOrBuilder() A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
com.google.protobuf.Struct	getPayload() Returns a response containing a custom, platform-specific payload.
com.google.protobuf.StructOrBuilder	getPayloadOrBuilder() Returns a response containing a custom, platform-specific payload.
ResponseMessage.PlayAudio	getPlayAudio() Signal that the client should play an audio clip hosted at a client-specific URI.
ResponseMessage.PlayAudioOrBuilder	getPlayAudioOrBuilder() Signal that the client should play an audio clip hosted at a client-specific URI.
ResponseMessage.ResponseType	getResponseType() Response type.
int	getResponseTypeValue() Response type.
ResponseMessage.TelephonyTransferCall	getTelephonyTransferCall() A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
ResponseMessage.TelephonyTransferCallOrBuilder	getTelephonyTransferCallOrBuilder() A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
ResponseMessage.Text	getText() Returns a text response.
ResponseMessage.TextOrBuilder	getTextOrBuilder() Returns a text response.
boolean	hasConversationSuccess() Indicates that the conversation succeeded.
boolean	hasEndInteraction() Output only.
boolean	hasKnowledgeInfoCard() Represents info card for knowledge answers, to be better rendered in Dialogflow Messenger.
boolean	hasLiveAgentHandoff() Hands off conversation to a human agent.
boolean	hasMixedAudio() Output only.
boolean	hasOutputAudioText() A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
boolean	hasPayload() Returns a response containing a custom, platform-specific payload.
boolean	hasPlayAudio() Signal that the client should play an audio clip hosted at a client-specific URI.
boolean	hasTelephonyTransferCall() A signal that the client should transfer the phone call connected to this agent to a third-party endpoint.
boolean	hasText() Returns a text response.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasText

boolean hasText()

 Returns a text response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;

Returns:

Whether the text field is set.

getText

ResponseMessage.Text getText()

 Returns a text response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;

Returns:

The text.

getTextOrBuilder

ResponseMessage.TextOrBuilder getTextOrBuilder()

 Returns a text response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;

hasPayload

boolean hasPayload()

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

.google.protobuf.Struct payload = 2;

Returns:

Whether the payload field is set.

getPayload

com.google.protobuf.Struct getPayload()

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

.google.protobuf.Struct payload = 2;

Returns:

The payload.

getPayloadOrBuilder

com.google.protobuf.StructOrBuilder getPayloadOrBuilder()

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

.google.protobuf.Struct payload = 2;

hasConversationSuccess

boolean hasConversationSuccess()

 Indicates that the conversation succeeded.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;

Returns:

Whether the conversationSuccess field is set.

getConversationSuccess

ResponseMessage.ConversationSuccess getConversationSuccess()

 Indicates that the conversation succeeded.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;

Returns:

The conversationSuccess.

getConversationSuccessOrBuilder

ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()

 Indicates that the conversation succeeded.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;

hasOutputAudioText

boolean hasOutputAudioText()

 A text or ssml response that is preferentially used for TTS output audio
 synthesis, as described in the comment on the ResponseMessage message.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.OutputAudioText output_audio_text = 8;

Returns:

Whether the outputAudioText field is set.

getOutputAudioText

ResponseMessage.OutputAudioText getOutputAudioText()

 A text or ssml response that is preferentially used for TTS output audio
 synthesis, as described in the comment on the ResponseMessage message.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.OutputAudioText output_audio_text = 8;

Returns:

The outputAudioText.

getOutputAudioTextOrBuilder

ResponseMessage.OutputAudioTextOrBuilder getOutputAudioTextOrBuilder()

 A text or ssml response that is preferentially used for TTS output audio
 synthesis, as described in the comment on the ResponseMessage message.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.OutputAudioText output_audio_text = 8;

hasLiveAgentHandoff

boolean hasLiveAgentHandoff()

 Hands off conversation to a human agent.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

Returns:

Whether the liveAgentHandoff field is set.

getLiveAgentHandoff

ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()

 Hands off conversation to a human agent.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

Returns:

The liveAgentHandoff.

getLiveAgentHandoffOrBuilder

ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()

 Hands off conversation to a human agent.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

hasEndInteraction

boolean hasEndInteraction()

 Output only. A signal that indicates the interaction with the Dialogflow
 agent has ended. This message is generated by Dialogflow only when the
 conversation reaches `END_SESSION` page. It is not supposed to be defined
 by the user.

 It's guaranteed that there is at most one such message in each response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the endInteraction field is set.

getEndInteraction

ResponseMessage.EndInteraction getEndInteraction()

 Output only. A signal that indicates the interaction with the Dialogflow
 agent has ended. This message is generated by Dialogflow only when the
 conversation reaches `END_SESSION` page. It is not supposed to be defined
 by the user.

 It's guaranteed that there is at most one such message in each response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The endInteraction.

getEndInteractionOrBuilder

ResponseMessage.EndInteractionOrBuilder getEndInteractionOrBuilder()

 Output only. A signal that indicates the interaction with the Dialogflow
 agent has ended. This message is generated by Dialogflow only when the
 conversation reaches `END_SESSION` page. It is not supposed to be defined
 by the user.

 It's guaranteed that there is at most one such message in each response.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.EndInteraction end_interaction = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasPlayAudio

boolean hasPlayAudio()

 Signal that the client should play an audio clip hosted at a
 client-specific URI. Dialogflow uses this to construct
 [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.PlayAudio play_audio = 12;

Returns:

Whether the playAudio field is set.

getPlayAudio

ResponseMessage.PlayAudio getPlayAudio()

 Signal that the client should play an audio clip hosted at a
 client-specific URI. Dialogflow uses this to construct
 [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.PlayAudio play_audio = 12;

Returns:

The playAudio.

getPlayAudioOrBuilder

ResponseMessage.PlayAudioOrBuilder getPlayAudioOrBuilder()

 Signal that the client should play an audio clip hosted at a
 client-specific URI. Dialogflow uses this to construct
 [mixed_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.PlayAudio play_audio = 12;

hasMixedAudio

boolean hasMixedAudio()

 Output only. An audio response message composed of both the synthesized
 Dialogflow agent responses and responses defined via
 [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the mixedAudio field is set.

getMixedAudio

ResponseMessage.MixedAudio getMixedAudio()

 Output only. An audio response message composed of both the synthesized
 Dialogflow agent responses and responses defined via
 [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The mixedAudio.

getMixedAudioOrBuilder

ResponseMessage.MixedAudioOrBuilder getMixedAudioOrBuilder()

 Output only. An audio response message composed of both the synthesized
 Dialogflow agent responses and responses defined via
 [play_audio][google.cloud.dialogflow.cx.v3.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.MixedAudio mixed_audio = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasTelephonyTransferCall

boolean hasTelephonyTransferCall()

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

.google.cloud.dialogflow.cx.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

Returns:

Whether the telephonyTransferCall field is set.

getTelephonyTransferCall

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.cx.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

Returns:

The telephonyTransferCall.

getTelephonyTransferCallOrBuilder

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.cx.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

hasKnowledgeInfoCard

boolean hasKnowledgeInfoCard()

 Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

Returns:

Whether the knowledgeInfoCard field is set.

getKnowledgeInfoCard

ResponseMessage.KnowledgeInfoCard getKnowledgeInfoCard()

 Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

Returns:

The knowledgeInfoCard.

getKnowledgeInfoCardOrBuilder

ResponseMessage.KnowledgeInfoCardOrBuilder getKnowledgeInfoCardOrBuilder()

 Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

getResponseTypeValue

int getResponseTypeValue()

 Response type.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;

Returns:

The enum numeric value on the wire for responseType.

getResponseType

ResponseMessage.ResponseType getResponseType()

 Response type.
 

.google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;

Returns:

The responseType.

getChannel

String getChannel()

 The channel which the response is associated with. Clients can specify the
 channel via
 [QueryParameters.channel][google.cloud.dialogflow.cx.v3.QueryParameters.channel],
 and only associated channel response will be returned.
 

string channel = 19;

Returns:

The channel.

getChannelBytes

com.google.protobuf.ByteString getChannelBytes()

 The channel which the response is associated with. Clients can specify the
 channel via
 [QueryParameters.channel][google.cloud.dialogflow.cx.v3.QueryParameters.channel],
 and only associated channel response will be returned.
 

string channel = 19;

Returns:

The bytes for channel.

getMessageCase

ResponseMessage.MessageCase getMessageCase()