/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/response_message.proto
package com.google.cloud.dialogflow.cx.v3beta1;
public interface ResponseMessageOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.ResponseMessage)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Returns a text response.
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;
*
* @return Whether the text field is set.
*/
boolean hasText();
/**
*
*
*
* Returns a text response.
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;
*
* @return The text.
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text getText();
/**
*
*
*
* Returns a text response.
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text text = 1;
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TextOrBuilder getTextOrBuilder();
/**
*
*
*
* Returns a response containing a custom, platform-specific payload.
*
*
* .google.protobuf.Struct payload = 2;
*
* @return Whether the payload field is set.
*/
boolean hasPayload();
/**
*
*
*
* Returns a response containing a custom, platform-specific payload.
*
*
* .google.protobuf.Struct payload = 2;
*
* @return The payload.
*/
com.google.protobuf.Struct getPayload();
/**
*
*
*
* Returns a response containing a custom, platform-specific payload.
*
*
* .google.protobuf.Struct payload = 2;
*/
com.google.protobuf.StructOrBuilder getPayloadOrBuilder();
/**
*
*
*
* Indicates that the conversation succeeded.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
*
*
* @return Whether the conversationSuccess field is set.
*/
boolean hasConversationSuccess();
/**
*
*
*
* Indicates that the conversation succeeded.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
*
*
* @return The conversationSuccess.
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess
getConversationSuccess();
/**
*
*
*
* Indicates that the conversation succeeded.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccess conversation_success = 9;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.ConversationSuccessOrBuilder
getConversationSuccessOrBuilder();
/**
*
*
*
* 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;
*
*
* @return Whether the outputAudioText field is set.
*/
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;
*
*
* @return The outputAudioText.
*/
com.google.cloud.dialogflow.cx.v3beta1.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;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.OutputAudioTextOrBuilder
getOutputAudioTextOrBuilder();
/**
*
*
*
* Hands off conversation to a human agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
*
*
* @return Whether the liveAgentHandoff field is set.
*/
boolean hasLiveAgentHandoff();
/**
*
*
*
* Hands off conversation to a human agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
*
*
* @return The liveAgentHandoff.
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff getLiveAgentHandoff();
/**
*
*
*
* Hands off conversation to a human agent.
*
*
*
* .google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoff live_agent_handoff = 10;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.LiveAgentHandoffOrBuilder
getLiveAgentHandoffOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the endInteraction field is set.
*/
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];
*
*
* @return The endInteraction.
*/
com.google.cloud.dialogflow.cx.v3beta1.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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.EndInteractionOrBuilder
getEndInteractionOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the playAudio field is set.
*/
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;
*
* @return The playAudio.
*/
com.google.cloud.dialogflow.cx.v3beta1.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;
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.PlayAudioOrBuilder getPlayAudioOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the mixedAudio field is set.
*/
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];
*
*
* @return The mixedAudio.
*/
com.google.cloud.dialogflow.cx.v3beta1.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];
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MixedAudioOrBuilder
getMixedAudioOrBuilder();
/**
*
*
*
* 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;
*
*
* @return Whether the telephonyTransferCall field is set.
*/
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;
*
*
* @return The telephonyTransferCall.
*/
com.google.cloud.dialogflow.cx.v3beta1.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;
*
*/
com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.TelephonyTransferCallOrBuilder
getTelephonyTransferCallOrBuilder();
/**
*
*
*
* 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;
*
* @return The channel.
*/
java.lang.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;
*
* @return The bytes for channel.
*/
com.google.protobuf.ByteString getChannelBytes();
public com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.MessageCase getMessageCase();
}