Package com.google.cloud.dialogflow.cx.v3

Class ResponseMessage.Builder

  • All Implemented Interfaces:
    ResponseMessageOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ResponseMessage
    public static final class ResponseMessage.Builder
extends com.google.protobuf.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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • clear

        public ResponseMessage.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • getDefaultInstanceForType

        public ResponseMessage getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ResponseMessage build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ResponseMessage buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ResponseMessage.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • setField

        public ResponseMessage.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • clearField

        public ResponseMessage.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • clearOneof

        public ResponseMessage.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • setRepeatedField

        public ResponseMessage.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • addRepeatedField

        public ResponseMessage.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • mergeFrom

        public ResponseMessage.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResponseMessage.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • mergeFrom

        public ResponseMessage.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResponseMessage.Builder>
        Throws:
        IOException

      • hasText

        public boolean hasText()
         Returns a text response.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;
        Specified by:
        hasText in interface ResponseMessageOrBuilder
        Returns:
        Whether the text field is set.

      • clearText

        public ResponseMessage.Builder clearText()
         Returns a text response.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;

      • getTextBuilder

        public ResponseMessage.Text.Builder getTextBuilder()
         Returns a text response.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.Text text = 1;

      • hasPayload

        public boolean hasPayload()
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;
        Specified by:
        hasPayload in interface ResponseMessageOrBuilder
        Returns:
        Whether the payload field is set.

      • getPayload

        public com.google.protobuf.Struct getPayload()
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;
        Specified by:
        getPayload in interface ResponseMessageOrBuilder
        Returns:
        The payload.

      • setPayload

        public ResponseMessage.Builder setPayload​(com.google.protobuf.Struct value)
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;

      • setPayload

        public ResponseMessage.Builder setPayload​(com.google.protobuf.Struct.Builder builderForValue)
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;

      • mergePayload

        public ResponseMessage.Builder mergePayload​(com.google.protobuf.Struct value)
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;

      • clearPayload

        public ResponseMessage.Builder clearPayload()
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;

      • getPayloadBuilder

        public com.google.protobuf.Struct.Builder getPayloadBuilder()
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;

      • getPayloadOrBuilder

        public com.google.protobuf.StructOrBuilder getPayloadOrBuilder()
         Returns a response containing a custom, platform-specific payload.
        .google.protobuf.Struct payload = 2;
        Specified by:
        getPayloadOrBuilder in interface ResponseMessageOrBuilder

      • hasConversationSuccess

        public boolean hasConversationSuccess()
         Indicates that the conversation succeeded.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;
        Specified by:
        hasConversationSuccess in interface ResponseMessageOrBuilder
        Returns:
        Whether the conversationSuccess field is set.

      • clearConversationSuccess

        public ResponseMessage.Builder clearConversationSuccess()
         Indicates that the conversation succeeded.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;

      • getConversationSuccessBuilder

        public ResponseMessage.ConversationSuccess.Builder getConversationSuccessBuilder()
         Indicates that the conversation succeeded.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ConversationSuccess conversation_success = 9;

      • 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;
        Specified by:
        hasOutputAudioText in interface ResponseMessageOrBuilder
        Returns:
        Whether the outputAudioText field is set.

      • 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;
        Specified by:
        getOutputAudioText in interface ResponseMessageOrBuilder
        Returns:
        The outputAudioText.

      • setOutputAudioText

        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;

      • setOutputAudioText

        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;

      • mergeOutputAudioText

        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;

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

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

      • hasLiveAgentHandoff

        public boolean hasLiveAgentHandoff()
         Hands off conversation to a human agent.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
        Specified by:
        hasLiveAgentHandoff in interface ResponseMessageOrBuilder
        Returns:
        Whether the liveAgentHandoff field is set.

      • clearLiveAgentHandoff

        public ResponseMessage.Builder clearLiveAgentHandoff()
         Hands off conversation to a human agent.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

      • getLiveAgentHandoffBuilder

        public ResponseMessage.LiveAgentHandoff.Builder getLiveAgentHandoffBuilder()
         Hands off conversation to a human agent.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;

      • hasEndInteraction

        public 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];
        Specified by:
        hasEndInteraction in interface ResponseMessageOrBuilder
        Returns:
        Whether the endInteraction field is set.

      • getEndInteraction

        public 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];
        Specified by:
        getEndInteraction in interface ResponseMessageOrBuilder
        Returns:
        The endInteraction.

      • setEndInteraction

        public ResponseMessage.Builder setEndInteraction​(ResponseMessage.EndInteraction value)
         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];

      • setEndInteraction

        public ResponseMessage.Builder setEndInteraction​(ResponseMessage.EndInteraction.Builder builderForValue)
         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];

      • mergeEndInteraction

        public ResponseMessage.Builder mergeEndInteraction​(ResponseMessage.EndInteraction value)
         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];

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

      • getEndInteractionBuilder

        public ResponseMessage.EndInteraction.Builder getEndInteractionBuilder()
         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];

      • getEndInteractionOrBuilder

        public 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];
        Specified by:
        getEndInteractionOrBuilder in interface ResponseMessageOrBuilder

      • hasPlayAudio

        public 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;
        Specified by:
        hasPlayAudio in interface ResponseMessageOrBuilder
        Returns:
        Whether the playAudio field is set.

      • getPlayAudio

        public 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;
        Specified by:
        getPlayAudio in interface ResponseMessageOrBuilder
        Returns:
        The playAudio.

      • setPlayAudio

        public ResponseMessage.Builder setPlayAudio​(ResponseMessage.PlayAudio value)
         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;

      • setPlayAudio

        public ResponseMessage.Builder setPlayAudio​(ResponseMessage.PlayAudio.Builder builderForValue)
         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;

      • mergePlayAudio

        public ResponseMessage.Builder mergePlayAudio​(ResponseMessage.PlayAudio value)
         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;

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

      • getPlayAudioBuilder

        public ResponseMessage.PlayAudio.Builder getPlayAudioBuilder()
         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;

      • getPlayAudioOrBuilder

        public 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;
        Specified by:
        getPlayAudioOrBuilder in interface ResponseMessageOrBuilder

      • hasMixedAudio

        public 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];
        Specified by:
        hasMixedAudio in interface ResponseMessageOrBuilder
        Returns:
        Whether the mixedAudio field is set.

      • getMixedAudio

        public 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];
        Specified by:
        getMixedAudio in interface ResponseMessageOrBuilder
        Returns:
        The mixedAudio.

      • setMixedAudio

        public ResponseMessage.Builder setMixedAudio​(ResponseMessage.MixedAudio value)
         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];

      • setMixedAudio

        public ResponseMessage.Builder setMixedAudio​(ResponseMessage.MixedAudio.Builder builderForValue)
         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];

      • mergeMixedAudio

        public ResponseMessage.Builder mergeMixedAudio​(ResponseMessage.MixedAudio value)
         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];

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

      • getMixedAudioBuilder

        public ResponseMessage.MixedAudio.Builder getMixedAudioBuilder()
         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];

      • getMixedAudioOrBuilder

        public 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];
        Specified by:
        getMixedAudioOrBuilder in interface ResponseMessageOrBuilder

      • 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;
        Specified by:
        hasTelephonyTransferCall in interface ResponseMessageOrBuilder
        Returns:
        Whether the telephonyTransferCall field is set.

      • setTelephonyTransferCall

        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;

      • setTelephonyTransferCall

        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;

      • mergeTelephonyTransferCall

        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;

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

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

      • 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;
        Specified by:
        hasKnowledgeInfoCard in interface ResponseMessageOrBuilder
        Returns:
        Whether the knowledgeInfoCard field is set.

      • setKnowledgeInfoCard

        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;

      • setKnowledgeInfoCard

        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;

      • mergeKnowledgeInfoCard

        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;

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

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

      • getResponseTypeValue

        public int getResponseTypeValue()
         Response type.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
        Specified by:
        getResponseTypeValue in interface ResponseMessageOrBuilder
        Returns:
        The enum numeric value on the wire for responseType.

      • setResponseTypeValue

        public ResponseMessage.Builder setResponseTypeValue​(int value)
         Response type.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
        Parameters:
        value - The enum numeric value on the wire for responseType to set.
        Returns:
        This builder for chaining.

      • setResponseType

        public ResponseMessage.Builder setResponseType​(ResponseMessage.ResponseType value)
         Response type.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
        Parameters:
        value - The responseType to set.
        Returns:
        This builder for chaining.

      • clearResponseType

        public ResponseMessage.Builder clearResponseType()
         Response type.
        .google.cloud.dialogflow.cx.v3.ResponseMessage.ResponseType response_type = 4;
        Returns:
        This builder for chaining.

      • getChannel

        public 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;
        Specified by:
        getChannel in interface ResponseMessageOrBuilder
        Returns:
        The channel.

      • getChannelBytes

        public 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;
        Specified by:
        getChannelBytes in interface ResponseMessageOrBuilder
        Returns:
        The bytes for channel.

      • setChannel

        public ResponseMessage.Builder setChannel​(String value)
         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;
        Parameters:
        value - The channel to set.
        Returns:
        This builder for chaining.

      • clearChannel

        public ResponseMessage.Builder clearChannel()
         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:
        This builder for chaining.

      • setChannelBytes

        public ResponseMessage.Builder setChannelBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for channel to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ResponseMessage.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>

      • mergeUnknownFields

        public final ResponseMessage.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResponseMessage.Builder>