Class DetectIntentResponse

  • All Implemented Interfaces:
    DetectIntentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class DetectIntentResponse
    extends com.google.protobuf.GeneratedMessageV3
    implements DetectIntentResponseOrBuilder
     The message returned from the DetectIntent method.
     
    Protobuf type google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse
    See Also:
    Serialized Form
    • Field Detail

      • RESPONSE_ID_FIELD_NUMBER

        public static final int RESPONSE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • QUERY_RESULT_FIELD_NUMBER

        public static final int QUERY_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OUTPUT_AUDIO_FIELD_NUMBER

        public static final int OUTPUT_AUDIO_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OUTPUT_AUDIO_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_AUDIO_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESPONSE_TYPE_FIELD_NUMBER

        public static final int RESPONSE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ALLOW_CANCELLATION_FIELD_NUMBER

        public static final int ALLOW_CANCELLATION_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • 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
      • getResponseId

        public String getResponseId()
         Output only. The unique identifier of the response. It can be used to
         locate a response in the training example set or for reporting issues.
         
        string response_id = 1;
        Specified by:
        getResponseId in interface DetectIntentResponseOrBuilder
        Returns:
        The responseId.
      • getResponseIdBytes

        public com.google.protobuf.ByteString getResponseIdBytes()
         Output only. The unique identifier of the response. It can be used to
         locate a response in the training example set or for reporting issues.
         
        string response_id = 1;
        Specified by:
        getResponseIdBytes in interface DetectIntentResponseOrBuilder
        Returns:
        The bytes for responseId.
      • hasQueryResult

        public boolean hasQueryResult()
         The result of the conversational query.
         
        .google.cloud.dialogflow.cx.v3beta1.QueryResult query_result = 2;
        Specified by:
        hasQueryResult in interface DetectIntentResponseOrBuilder
        Returns:
        Whether the queryResult field is set.
      • getOutputAudio

        public com.google.protobuf.ByteString getOutputAudio()
         The audio data bytes encoded as specified in the request.
         Note: The output audio is generated based on the values of default platform
         text responses found in the
         [`query_result.response_messages`][google.cloud.dialogflow.cx.v3beta1.QueryResult.response_messages]
         field. If multiple default text responses exist, they will be concatenated
         when generating audio. If no default platform text responses exist, the
         generated audio content will be empty.
        
         In some scenarios, multiple output audio fields may be present in the
         response structure. In these cases, only the top-most-level audio output
         has content.
         
        bytes output_audio = 4;
        Specified by:
        getOutputAudio in interface DetectIntentResponseOrBuilder
        Returns:
        The outputAudio.
      • hasOutputAudioConfig

        public boolean hasOutputAudioConfig()
         The config used by the speech synthesizer to generate the output audio.
         
        .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 5;
        Specified by:
        hasOutputAudioConfig in interface DetectIntentResponseOrBuilder
        Returns:
        Whether the outputAudioConfig field is set.
      • getOutputAudioConfig

        public OutputAudioConfig getOutputAudioConfig()
         The config used by the speech synthesizer to generate the output audio.
         
        .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 5;
        Specified by:
        getOutputAudioConfig in interface DetectIntentResponseOrBuilder
        Returns:
        The outputAudioConfig.
      • getResponseTypeValue

        public int getResponseTypeValue()
         Response type.
         
        .google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse.ResponseType response_type = 6;
        Specified by:
        getResponseTypeValue in interface DetectIntentResponseOrBuilder
        Returns:
        The enum numeric value on the wire for responseType.
      • getAllowCancellation

        public boolean getAllowCancellation()
         Indicates whether the partial response can be cancelled when a later
         response arrives. e.g. if the agent specified some music as partial
         response, it can be cancelled.
         
        bool allow_cancellation = 7;
        Specified by:
        getAllowCancellation in interface DetectIntentResponseOrBuilder
        Returns:
        The allowCancellation.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static DetectIntentResponse parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DetectIntentResponse parseFrom​(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DetectIntentResponse parseFrom​(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DetectIntentResponse parseFrom​(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DetectIntentResponse parseFrom​(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static DetectIntentResponse parseFrom​(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

        public DetectIntentResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public DetectIntentResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected DetectIntentResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<DetectIntentResponse> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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