Class ResponseMessage.Builder (0.66.0)

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

Represents a response message that can be returned by a conversational agent.

Response messages are also used for output audio synthesis. The approach is as follows:

If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis.
If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design.
Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis.

This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

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

Inheritance

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

Implements

ResponseMessageOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ResponseMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ResponseMessage build()

Returns
Type	Description
`ResponseMessage`

buildPartial()

public ResponseMessage buildPartial()

Returns
Type	Description
`ResponseMessage`

clear()

public ResponseMessage.Builder clear()

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearChannel()

public ResponseMessage.Builder clearChannel()

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

string channel = 19;

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

clearConversationSuccess()

public ResponseMessage.Builder clearConversationSuccess()

Indicates that the conversation succeeded.

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

Returns
Type	Description
`ResponseMessage.Builder`

clearEndInteraction()

public ResponseMessage.Builder clearEndInteraction()

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
Type	Description
`ResponseMessage.Builder`

clearField(Descriptors.FieldDescriptor field)

public ResponseMessage.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearKnowledgeInfoCard()

public ResponseMessage.Builder clearKnowledgeInfoCard()

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
Type	Description
`ResponseMessage.Builder`

clearLiveAgentHandoff()

public ResponseMessage.Builder clearLiveAgentHandoff()

Hands off conversation to a human agent.

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

Returns
Type	Description
`ResponseMessage.Builder`

clearMessage()

public ResponseMessage.Builder clearMessage()

Returns
Type	Description
`ResponseMessage.Builder`

clearMixedAudio()

public ResponseMessage.Builder clearMixedAudio()

Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via 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
Type	Description
`ResponseMessage.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public ResponseMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOutputAudioText()

public ResponseMessage.Builder clearOutputAudioText()

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
Type	Description
`ResponseMessage.Builder`

clearPayload()

public ResponseMessage.Builder clearPayload()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
`ResponseMessage.Builder`

clearPlayAudio()

public ResponseMessage.Builder clearPlayAudio()

Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct 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
Type	Description
`ResponseMessage.Builder`

clearResponseType()

public ResponseMessage.Builder clearResponseType()

Response type.

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

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

clearTelephonyTransferCall()

public ResponseMessage.Builder clearTelephonyTransferCall()

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
Type	Description
`ResponseMessage.Builder`

clearText()

public ResponseMessage.Builder clearText()

Returns a text response.

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

Returns
Type	Description
`ResponseMessage.Builder`

clone()

public ResponseMessage.Builder clone()

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getChannel()

public String getChannel()

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

string channel = 19;

Returns
Type	Description
`String`	The channel.

getChannelBytes()

public ByteString getChannelBytes()

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

string channel = 19;

Returns
Type	Description
`ByteString`	The bytes for channel.

getConversationSuccess()

public ResponseMessage.ConversationSuccess getConversationSuccess()

Indicates that the conversation succeeded.

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

Returns
Type	Description
`ResponseMessage.ConversationSuccess`	The conversationSuccess.

getConversationSuccessBuilder()

public ResponseMessage.ConversationSuccess.Builder getConversationSuccessBuilder()

Indicates that the conversation succeeded.

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

Returns
Type	Description
`ResponseMessage.ConversationSuccess.Builder`

getConversationSuccessOrBuilder()

public ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()

Indicates that the conversation succeeded.

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

Returns
Type	Description
`ResponseMessage.ConversationSuccessOrBuilder`

getDefaultInstanceForType()

public ResponseMessage getDefaultInstanceForType()

Returns
Type	Description
`ResponseMessage`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEndInteraction()

public ResponseMessage.EndInteraction getEndInteraction()

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
Type	Description
`ResponseMessage.EndInteraction`	The endInteraction.

getEndInteractionBuilder()

public ResponseMessage.EndInteraction.Builder getEndInteractionBuilder()

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
Type	Description
`ResponseMessage.EndInteraction.Builder`

getEndInteractionOrBuilder()

public ResponseMessage.EndInteractionOrBuilder getEndInteractionOrBuilder()

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
Type	Description
`ResponseMessage.EndInteractionOrBuilder`

getKnowledgeInfoCard()

public 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
Type	Description
`ResponseMessage.KnowledgeInfoCard`	The knowledgeInfoCard.

getKnowledgeInfoCardBuilder()

public ResponseMessage.KnowledgeInfoCard.Builder getKnowledgeInfoCardBuilder()

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
Type	Description
`ResponseMessage.KnowledgeInfoCard.Builder`

getKnowledgeInfoCardOrBuilder()

public 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;

Returns
Type	Description
`ResponseMessage.KnowledgeInfoCardOrBuilder`

getLiveAgentHandoff()

public ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()

Hands off conversation to a human agent.

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

Returns
Type	Description
`ResponseMessage.LiveAgentHandoff`	The liveAgentHandoff.

getLiveAgentHandoffBuilder()

public ResponseMessage.LiveAgentHandoff.Builder getLiveAgentHandoffBuilder()

Hands off conversation to a human agent.

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

Returns
Type	Description
`ResponseMessage.LiveAgentHandoff.Builder`

getLiveAgentHandoffOrBuilder()

public ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()

Hands off conversation to a human agent.

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

Returns
Type	Description
`ResponseMessage.LiveAgentHandoffOrBuilder`

getMessageCase()

public ResponseMessage.MessageCase getMessageCase()

Returns
Type	Description
`ResponseMessage.MessageCase`

getMixedAudio()

public ResponseMessage.MixedAudio getMixedAudio()

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

Returns
Type	Description
`ResponseMessage.MixedAudio`	The mixedAudio.

getMixedAudioBuilder()

public ResponseMessage.MixedAudio.Builder getMixedAudioBuilder()

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

Returns
Type	Description
`ResponseMessage.MixedAudio.Builder`

getMixedAudioOrBuilder()

public ResponseMessage.MixedAudioOrBuilder getMixedAudioOrBuilder()

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

Returns
Type	Description
`ResponseMessage.MixedAudioOrBuilder`

getOutputAudioText()

public 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
Type	Description
`ResponseMessage.OutputAudioText`	The outputAudioText.

getOutputAudioTextBuilder()

public ResponseMessage.OutputAudioText.Builder getOutputAudioTextBuilder()

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
Type	Description
`ResponseMessage.OutputAudioText.Builder`

getOutputAudioTextOrBuilder()

public 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;

Returns
Type	Description
`ResponseMessage.OutputAudioTextOrBuilder`

getPayload()

public Struct getPayload()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
`Struct`	The payload.

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
`Builder`

getPayloadOrBuilder()

public StructOrBuilder getPayloadOrBuilder()

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

.google.protobuf.Struct payload = 2;

Returns
Type	Description
`StructOrBuilder`

getPlayAudio()

public ResponseMessage.PlayAudio getPlayAudio()

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

Returns
Type	Description
`ResponseMessage.PlayAudio`	The playAudio.

getPlayAudioBuilder()

public ResponseMessage.PlayAudio.Builder getPlayAudioBuilder()

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

Returns
Type	Description
`ResponseMessage.PlayAudio.Builder`

getPlayAudioOrBuilder()

public ResponseMessage.PlayAudioOrBuilder getPlayAudioOrBuilder()

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

Returns
Type	Description
`ResponseMessage.PlayAudioOrBuilder`

getResponseType()

public ResponseMessage.ResponseType getResponseType()

Response type.

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

Returns
Type	Description
`ResponseMessage.ResponseType`	The responseType.

getResponseTypeValue()

public int getResponseTypeValue()

Response type.

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

Returns
Type	Description
`int`	The enum numeric value on the wire for responseType.

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

Returns
Type	Description
`ResponseMessage.TelephonyTransferCall`	The telephonyTransferCall.

getTelephonyTransferCallBuilder()

public ResponseMessage.TelephonyTransferCall.Builder getTelephonyTransferCallBuilder()

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
Type	Description
`ResponseMessage.TelephonyTransferCall.Builder`

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

Returns
Type	Description
`ResponseMessage.TelephonyTransferCallOrBuilder`

getText()

public ResponseMessage.Text getText()

Returns a text response.

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

Returns
Type	Description
`ResponseMessage.Text`	The text.

getTextBuilder()

public ResponseMessage.Text.Builder getTextBuilder()

Returns a text response.

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

Returns
Type	Description
`ResponseMessage.Text.Builder`

getTextOrBuilder()

public ResponseMessage.TextOrBuilder getTextOrBuilder()

Returns a text response.

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

Returns
Type	Description
`ResponseMessage.TextOrBuilder`

hasConversationSuccess()

public boolean hasConversationSuccess()

Indicates that the conversation succeeded.

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

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

hasEndInteraction()

public boolean hasEndInteraction()

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
Type	Description
`boolean`	Whether the endInteraction field is set.

hasKnowledgeInfoCard()

public 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
Type	Description
`boolean`	Whether the knowledgeInfoCard field is set.

hasLiveAgentHandoff()

public boolean hasLiveAgentHandoff()

Hands off conversation to a human agent.

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

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

hasMixedAudio()

public boolean hasMixedAudio()

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

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

hasOutputAudioText()

public 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
Type	Description
`boolean`	Whether the outputAudioText 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.

hasPlayAudio()

public boolean hasPlayAudio()

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

Returns
Type	Description
`boolean`	Whether the playAudio 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.cx.v3.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

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

hasText()

public boolean hasText()

Returns a text response.

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeConversationSuccess(ResponseMessage.ConversationSuccess value)

public ResponseMessage.Builder mergeConversationSuccess(ResponseMessage.ConversationSuccess value)

Indicates that the conversation succeeded.

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

Parameter
Name	Description
`value`	`ResponseMessage.ConversationSuccess`

Returns
Type	Description
`ResponseMessage.Builder`

mergeEndInteraction(ResponseMessage.EndInteraction value)

public ResponseMessage.Builder mergeEndInteraction(ResponseMessage.EndInteraction value)

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];

Parameter
Name	Description
`value`	`ResponseMessage.EndInteraction`

Returns
Type	Description
`ResponseMessage.Builder`

mergeFrom(ResponseMessage other)

public ResponseMessage.Builder mergeFrom(ResponseMessage other)

Parameter
Name	Description
`other`	`ResponseMessage`

Returns
Type	Description
`ResponseMessage.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ResponseMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ResponseMessage.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard value)

public ResponseMessage.Builder mergeKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard value)

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

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

Parameter
Name	Description
`value`	`ResponseMessage.KnowledgeInfoCard`

Returns
Type	Description
`ResponseMessage.Builder`

mergeLiveAgentHandoff(ResponseMessage.LiveAgentHandoff value)

public ResponseMessage.Builder mergeLiveAgentHandoff(ResponseMessage.LiveAgentHandoff value)

Hands off conversation to a human agent.

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

Parameter
Name	Description
`value`	`ResponseMessage.LiveAgentHandoff`

Returns
Type	Description
`ResponseMessage.Builder`

mergeMixedAudio(ResponseMessage.MixedAudio value)

public ResponseMessage.Builder mergeMixedAudio(ResponseMessage.MixedAudio value)

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

Parameter
Name	Description
`value`	`ResponseMessage.MixedAudio`

Returns
Type	Description
`ResponseMessage.Builder`

mergeOutputAudioText(ResponseMessage.OutputAudioText value)

public ResponseMessage.Builder mergeOutputAudioText(ResponseMessage.OutputAudioText value)

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;

Parameter
Name	Description
`value`	`ResponseMessage.OutputAudioText`

Returns
Type	Description
`ResponseMessage.Builder`

mergePayload(Struct value)

public ResponseMessage.Builder mergePayload(Struct value)

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

.google.protobuf.Struct payload = 2;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`ResponseMessage.Builder`

mergePlayAudio(ResponseMessage.PlayAudio value)

public ResponseMessage.Builder mergePlayAudio(ResponseMessage.PlayAudio value)

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

Parameter
Name	Description
`value`	`ResponseMessage.PlayAudio`

Returns
Type	Description
`ResponseMessage.Builder`

mergeTelephonyTransferCall(ResponseMessage.TelephonyTransferCall value)

public ResponseMessage.Builder mergeTelephonyTransferCall(ResponseMessage.TelephonyTransferCall value)

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;

Parameter
Name	Description
`value`	`ResponseMessage.TelephonyTransferCall`

Returns
Type	Description
`ResponseMessage.Builder`

mergeText(ResponseMessage.Text value)

public ResponseMessage.Builder mergeText(ResponseMessage.Text value)

Returns a text response.

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

Parameter
Name	Description
`value`	`ResponseMessage.Text`

Returns
Type	Description
`ResponseMessage.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setChannel(String value)

public ResponseMessage.Builder setChannel(String value)

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

string channel = 19;

Parameter
Name	Description
`value`	`String` The channel to set.

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

setChannelBytes(ByteString value)

public ResponseMessage.Builder setChannelBytes(ByteString value)

The channel which the response is associated with. Clients can specify the channel via QueryParameters.channel, and only associated channel response will be returned.

string channel = 19;

Parameter
Name	Description
`value`	`ByteString` The bytes for channel to set.

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

setConversationSuccess(ResponseMessage.ConversationSuccess value)

public ResponseMessage.Builder setConversationSuccess(ResponseMessage.ConversationSuccess value)

Indicates that the conversation succeeded.

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

Parameter
Name	Description
`value`	`ResponseMessage.ConversationSuccess`

Returns
Type	Description
`ResponseMessage.Builder`

setConversationSuccess(ResponseMessage.ConversationSuccess.Builder builderForValue)

public ResponseMessage.Builder setConversationSuccess(ResponseMessage.ConversationSuccess.Builder builderForValue)

Indicates that the conversation succeeded.

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.ConversationSuccess.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setEndInteraction(ResponseMessage.EndInteraction value)

public ResponseMessage.Builder setEndInteraction(ResponseMessage.EndInteraction value)

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];

Parameter
Name	Description
`value`	`ResponseMessage.EndInteraction`

Returns
Type	Description
`ResponseMessage.Builder`

setEndInteraction(ResponseMessage.EndInteraction.Builder builderForValue)

public ResponseMessage.Builder setEndInteraction(ResponseMessage.EndInteraction.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`ResponseMessage.EndInteraction.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public ResponseMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard value)

public ResponseMessage.Builder setKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard value)

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

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

Parameter
Name	Description
`value`	`ResponseMessage.KnowledgeInfoCard`

Returns
Type	Description
`ResponseMessage.Builder`

setKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard.Builder builderForValue)

public ResponseMessage.Builder setKnowledgeInfoCard(ResponseMessage.KnowledgeInfoCard.Builder builderForValue)

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

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.KnowledgeInfoCard.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setLiveAgentHandoff(ResponseMessage.LiveAgentHandoff value)

public ResponseMessage.Builder setLiveAgentHandoff(ResponseMessage.LiveAgentHandoff value)

Hands off conversation to a human agent.

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

Parameter
Name	Description
`value`	`ResponseMessage.LiveAgentHandoff`

Returns
Type	Description
`ResponseMessage.Builder`

setLiveAgentHandoff(ResponseMessage.LiveAgentHandoff.Builder builderForValue)

public ResponseMessage.Builder setLiveAgentHandoff(ResponseMessage.LiveAgentHandoff.Builder builderForValue)

Hands off conversation to a human agent.

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.LiveAgentHandoff.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setMixedAudio(ResponseMessage.MixedAudio value)

public ResponseMessage.Builder setMixedAudio(ResponseMessage.MixedAudio value)

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

Parameter
Name	Description
`value`	`ResponseMessage.MixedAudio`

Returns
Type	Description
`ResponseMessage.Builder`

setMixedAudio(ResponseMessage.MixedAudio.Builder builderForValue)

public ResponseMessage.Builder setMixedAudio(ResponseMessage.MixedAudio.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.MixedAudio.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setOutputAudioText(ResponseMessage.OutputAudioText value)

public ResponseMessage.Builder setOutputAudioText(ResponseMessage.OutputAudioText value)

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;

Parameter
Name	Description
`value`	`ResponseMessage.OutputAudioText`

Returns
Type	Description
`ResponseMessage.Builder`

setOutputAudioText(ResponseMessage.OutputAudioText.Builder builderForValue)

public ResponseMessage.Builder setOutputAudioText(ResponseMessage.OutputAudioText.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`ResponseMessage.OutputAudioText.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setPayload(Struct value)

public ResponseMessage.Builder setPayload(Struct value)

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

.google.protobuf.Struct payload = 2;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`ResponseMessage.Builder`

setPayload(Struct.Builder builderForValue)

public ResponseMessage.Builder setPayload(Struct.Builder builderForValue)

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

.google.protobuf.Struct payload = 2;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setPlayAudio(ResponseMessage.PlayAudio value)

public ResponseMessage.Builder setPlayAudio(ResponseMessage.PlayAudio value)

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

Parameter
Name	Description
`value`	`ResponseMessage.PlayAudio`

Returns
Type	Description
`ResponseMessage.Builder`

setPlayAudio(ResponseMessage.PlayAudio.Builder builderForValue)

public ResponseMessage.Builder setPlayAudio(ResponseMessage.PlayAudio.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.PlayAudio.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setResponseType(ResponseMessage.ResponseType value)

public ResponseMessage.Builder setResponseType(ResponseMessage.ResponseType value)

Response type.

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

Parameter
Name	Description
`value`	`ResponseMessage.ResponseType` The responseType to set.

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

setResponseTypeValue(int value)

public ResponseMessage.Builder setResponseTypeValue(int value)

Response type.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for responseType to set.

Returns
Type	Description
`ResponseMessage.Builder`	This builder for chaining.

setTelephonyTransferCall(ResponseMessage.TelephonyTransferCall value)

public ResponseMessage.Builder setTelephonyTransferCall(ResponseMessage.TelephonyTransferCall value)

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;

Parameter
Name	Description
`value`	`ResponseMessage.TelephonyTransferCall`

Returns
Type	Description
`ResponseMessage.Builder`

setTelephonyTransferCall(ResponseMessage.TelephonyTransferCall.Builder builderForValue)

public ResponseMessage.Builder setTelephonyTransferCall(ResponseMessage.TelephonyTransferCall.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`ResponseMessage.TelephonyTransferCall.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setText(ResponseMessage.Text value)

public ResponseMessage.Builder setText(ResponseMessage.Text value)

Returns a text response.

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

Parameter
Name	Description
`value`	`ResponseMessage.Text`

Returns
Type	Description
`ResponseMessage.Builder`

setText(ResponseMessage.Text.Builder builderForValue)

public ResponseMessage.Builder setText(ResponseMessage.Text.Builder builderForValue)

Returns a text response.

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

Parameter
Name	Description
`builderForValue`	`ResponseMessage.Text.Builder`

Returns
Type	Description
`ResponseMessage.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final ResponseMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ResponseMessage.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)