Package com.google.cloud.dialogflow.cx.v3beta1

Class ResponseMessage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ResponseMessage.Builder>
com.google.cloud.dialogflow.cx.v3beta1.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.GeneratedMessage.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.v3beta1.ResponseMessage

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • mergeFrom

      public ResponseMessage.Builder mergeFrom(ResponseMessage other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • getMessageCase

      public ResponseMessage.MessageCase getMessageCase()
      Specified by:
      getMessageCase in interface ResponseMessageOrBuilder

    • clearMessage

      public ResponseMessage.Builder clearMessage()

    • hasText

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

    • getText

      public ResponseMessage.Text getText()
       Returns a text response.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;
      Specified by:
      getText in interface ResponseMessageOrBuilder
      Returns:
      The text.

    • setText

      public ResponseMessage.Builder setText(ResponseMessage.Text value)
       Returns a text response.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

    • setText

      public ResponseMessage.Builder setText(ResponseMessage.Text.Builder builderForValue)
       Returns a text response.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

    • mergeText

      public ResponseMessage.Builder mergeText(ResponseMessage.Text value)
       Returns a text response.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;

    • clearText

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

    • getTextBuilder

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

    • getTextOrBuilder

      public ResponseMessage.TextOrBuilder getTextOrBuilder()
       Returns a text response.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;
      Specified by:
      getTextOrBuilder in interface ResponseMessageOrBuilder

    • 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.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
      Specified by:
      hasConversationSuccess in interface ResponseMessageOrBuilder
      Returns:
      Whether the conversationSuccess field is set.

    • getConversationSuccess

      public ResponseMessage.ConversationSuccess getConversationSuccess()
       Indicates that the conversation succeeded.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
      Specified by:
      getConversationSuccess in interface ResponseMessageOrBuilder
      Returns:
      The conversationSuccess.

    • setConversationSuccess

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

    • setConversationSuccess

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

    • mergeConversationSuccess

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

    • clearConversationSuccess

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

    • getConversationSuccessBuilder

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

    • getConversationSuccessOrBuilder

      public ResponseMessage.ConversationSuccessOrBuilder getConversationSuccessOrBuilder()
       Indicates that the conversation succeeded.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
      Specified by:
      getConversationSuccessOrBuilder in interface ResponseMessageOrBuilder

    • 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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.ResponseMessage.OutputAudioText output_audio_text = 8;

    • 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.v3beta1.ResponseMessage.OutputAudioText output_audio_text = 8;
      Specified by:
      getOutputAudioTextOrBuilder in interface ResponseMessageOrBuilder

    • hasLiveAgentHandoff

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

    • getLiveAgentHandoff

      public ResponseMessage.LiveAgentHandoff getLiveAgentHandoff()
       Hands off conversation to a human agent.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
      Specified by:
      getLiveAgentHandoff in interface ResponseMessageOrBuilder
      Returns:
      The liveAgentHandoff.

    • setLiveAgentHandoff

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

    • setLiveAgentHandoff

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

    • mergeLiveAgentHandoff

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

    • clearLiveAgentHandoff

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

    • getLiveAgentHandoffBuilder

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

    • getLiveAgentHandoffOrBuilder

      public ResponseMessage.LiveAgentHandoffOrBuilder getLiveAgentHandoffOrBuilder()
       Hands off conversation to a human agent.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
      Specified by:
      getLiveAgentHandoffOrBuilder in interface ResponseMessageOrBuilder

    • 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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.mixed_audio].
 However, Dialogflow itself does not try to read or process the URI in any
 way.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.play_audio].
 This message is generated by Dialogflow only and not supposed to be
 defined by the user.
      .google.cloud.dialogflow.cx.v3beta1.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.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
      Specified by:
      hasTelephonyTransferCall in interface ResponseMessageOrBuilder
      Returns:
      Whether the telephonyTransferCall field is set.

    • 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.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
      Specified by:
      getTelephonyTransferCall in interface ResponseMessageOrBuilder
      Returns:
      The telephonyTransferCall.

    • 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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;

    • 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.v3beta1.ResponseMessage.TelephonyTransferCall telephony_transfer_call = 18;
      Specified by:
      getTelephonyTransferCallOrBuilder in interface ResponseMessageOrBuilder

    • hasKnowledgeInfoCard

      public boolean hasKnowledgeInfoCard()
       Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
      Specified by:
      hasKnowledgeInfoCard in interface ResponseMessageOrBuilder
      Returns:
      Whether the knowledgeInfoCard field is set.

    • getKnowledgeInfoCard

      public ResponseMessage.KnowledgeInfoCard getKnowledgeInfoCard()
       Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
      Specified by:
      getKnowledgeInfoCard in interface ResponseMessageOrBuilder
      Returns:
      The knowledgeInfoCard.

    • 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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;

    • getKnowledgeInfoCardOrBuilder

      public ResponseMessage.KnowledgeInfoCardOrBuilder getKnowledgeInfoCardOrBuilder()
       Represents info card for knowledge answers, to be better rendered in
 Dialogflow Messenger.
      .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.KnowledgeInfoCard knowledge_info_card = 20;
      Specified by:
      getKnowledgeInfoCardOrBuilder in interface ResponseMessageOrBuilder

    • hasToolCall

      public boolean hasToolCall()
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;
      Specified by:
      hasToolCall in interface ResponseMessageOrBuilder
      Returns:
      Whether the toolCall field is set.

    • getToolCall

      public ToolCall getToolCall()
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;
      Specified by:
      getToolCall in interface ResponseMessageOrBuilder
      Returns:
      The toolCall.

    • setToolCall

      public ResponseMessage.Builder setToolCall(ToolCall value)
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

    • setToolCall

      public ResponseMessage.Builder setToolCall(ToolCall.Builder builderForValue)
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

    • mergeToolCall

      public ResponseMessage.Builder mergeToolCall(ToolCall value)
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

    • clearToolCall

      public ResponseMessage.Builder clearToolCall()
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

    • getToolCallBuilder

      public ToolCall.Builder getToolCallBuilder()
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;

    • getToolCallOrBuilder

      public ToolCallOrBuilder getToolCallOrBuilder()
       Returns the definition of a tool call that should be executed by the
 client.
      .google.cloud.dialogflow.cx.v3beta1.ToolCall tool_call = 22;
      Specified by:
      getToolCallOrBuilder in interface ResponseMessageOrBuilder

    • getChannel

      public String getChannel()
       The channel which the response is associated with. Clients can specify the
 channel via
 [QueryParameters.channel][google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.v3beta1.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.