Class QueryResult

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

    public final class QueryResult
    extends com.google.protobuf.GeneratedMessageV3
    implements QueryResultOrBuilder
     Represents the result of a conversational query.
     
    Protobuf type google.cloud.dialogflow.cx.v3.QueryResult
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  QueryResult.Builder
      Represents the result of a conversational query.
      static class  QueryResult.QueryCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      Page getCurrentPage()
      The current [Page][google.cloud.dialogflow.cx.v3.Page].
      PageOrBuilder getCurrentPageOrBuilder()
      The current [Page][google.cloud.dialogflow.cx.v3.Page].
      static QueryResult getDefaultInstance()  
      QueryResult getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Struct getDiagnosticInfo()
      The free-form diagnostic info.
      com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder()
      The free-form diagnostic info.
      DtmfInput getDtmf()
      If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain a copy of the [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
      DtmfInputOrBuilder getDtmfOrBuilder()
      If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain a copy of the [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
      Intent getIntent()
      Deprecated.
      google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated.
      float getIntentDetectionConfidence()
      Deprecated.
      google.cloud.dialogflow.cx.v3.QueryResult.intent_detection_confidence is deprecated.
      IntentOrBuilder getIntentOrBuilder()
      Deprecated.
      String getLanguageCode()
      The language that was triggered during intent detection.
      com.google.protobuf.ByteString getLanguageCodeBytes()
      The language that was triggered during intent detection.
      Match getMatch()
      Intent match result, could be an intent or an event.
      MatchOrBuilder getMatchOrBuilder()
      Intent match result, could be an intent or an event.
      com.google.protobuf.Struct getParameters()
      The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
      com.google.protobuf.StructOrBuilder getParametersOrBuilder()
      The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
      com.google.protobuf.Parser<QueryResult> getParserForType()  
      QueryResult.QueryCase getQueryCase()  
      ResponseMessage getResponseMessages​(int index)
      The list of rich messages returned to the client.
      int getResponseMessagesCount()
      The list of rich messages returned to the client.
      List<ResponseMessage> getResponseMessagesList()
      The list of rich messages returned to the client.
      ResponseMessageOrBuilder getResponseMessagesOrBuilder​(int index)
      The list of rich messages returned to the client.
      List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()
      The list of rich messages returned to the client.
      SentimentAnalysisResult getSentimentAnalysisResult()
      The sentiment analyss result, which depends on [`analyze_query_text_sentiment`] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.
      SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
      The sentiment analyss result, which depends on [`analyze_query_text_sentiment`] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.
      int getSerializedSize()  
      String getText()
      If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
      com.google.protobuf.ByteString getTextBytes()
      If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
      String getTranscript()
      If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
      com.google.protobuf.ByteString getTranscriptBytes()
      If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
      String getTriggerEvent()
      If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
      com.google.protobuf.ByteString getTriggerEventBytes()
      If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
      String getTriggerIntent()
      If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier.
      com.google.protobuf.ByteString getTriggerIntentBytes()
      If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier.
      com.google.protobuf.Struct getWebhookPayloads​(int index)
      The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence.
      int getWebhookPayloadsCount()
      The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence.
      List<com.google.protobuf.Struct> getWebhookPayloadsList()
      The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence.
      com.google.protobuf.StructOrBuilder getWebhookPayloadsOrBuilder​(int index)
      The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence.
      List<? extends com.google.protobuf.StructOrBuilder> getWebhookPayloadsOrBuilderList()
      The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload], in the order of call sequence.
      com.google.rpc.Status getWebhookStatuses​(int index)
      The list of webhook call status in the order of call sequence.
      int getWebhookStatusesCount()
      The list of webhook call status in the order of call sequence.
      List<com.google.rpc.Status> getWebhookStatusesList()
      The list of webhook call status in the order of call sequence.
      com.google.rpc.StatusOrBuilder getWebhookStatusesOrBuilder​(int index)
      The list of webhook call status in the order of call sequence.
      List<? extends com.google.rpc.StatusOrBuilder> getWebhookStatusesOrBuilderList()
      The list of webhook call status in the order of call sequence.
      boolean hasCurrentPage()
      The current [Page][google.cloud.dialogflow.cx.v3.Page].
      boolean hasDiagnosticInfo()
      The free-form diagnostic info.
      boolean hasDtmf()
      If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input, this field will contain a copy of the [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
      int hashCode()  
      boolean hasIntent()
      Deprecated.
      google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated.
      boolean hasMatch()
      Intent match result, could be an intent or an event.
      boolean hasParameters()
      The collected [session parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
      boolean hasSentimentAnalysisResult()
      The sentiment analyss result, which depends on [`analyze_query_text_sentiment`] [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment], specified in the request.
      boolean hasText()
      If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was provided as input, this field will contain a copy of the text.
      boolean hasTranscript()
      If [natural language speech audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input, this field will contain the transcript for the audio.
      boolean hasTriggerEvent()
      If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as input, this field will contain the name of the event.
      boolean hasTriggerIntent()
      If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as input, this field will contain a copy of the intent identifier.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static QueryResult.Builder newBuilder()  
      static QueryResult.Builder newBuilder​(QueryResult prototype)  
      QueryResult.Builder newBuilderForType()  
      protected QueryResult.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static QueryResult parseDelimitedFrom​(InputStream input)  
      static QueryResult parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static QueryResult parseFrom​(byte[] data)  
      static QueryResult parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static QueryResult parseFrom​(com.google.protobuf.ByteString data)  
      static QueryResult parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static QueryResult parseFrom​(com.google.protobuf.CodedInputStream input)  
      static QueryResult parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static QueryResult parseFrom​(InputStream input)  
      static QueryResult parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static QueryResult parseFrom​(ByteBuffer data)  
      static QueryResult parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<QueryResult> parser()  
      QueryResult.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • TRIGGER_INTENT_FIELD_NUMBER

        public static final int TRIGGER_INTENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRANSCRIPT_FIELD_NUMBER

        public static final int TRANSCRIPT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRIGGER_EVENT_FIELD_NUMBER

        public static final int TRIGGER_EVENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • LANGUAGE_CODE_FIELD_NUMBER

        public static final int LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PARAMETERS_FIELD_NUMBER

        public static final int PARAMETERS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESPONSE_MESSAGES_FIELD_NUMBER

        public static final int RESPONSE_MESSAGES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • WEBHOOK_STATUSES_FIELD_NUMBER

        public static final int WEBHOOK_STATUSES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • WEBHOOK_PAYLOADS_FIELD_NUMBER

        public static final int WEBHOOK_PAYLOADS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CURRENT_PAGE_FIELD_NUMBER

        public static final int CURRENT_PAGE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER

        public static final int INTENT_DETECTION_CONFIDENCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DIAGNOSTIC_INFO_FIELD_NUMBER

        public static final int DIAGNOSTIC_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SENTIMENT_ANALYSIS_RESULT_FIELD_NUMBER

        public static final int SENTIMENT_ANALYSIS_RESULT_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
      • hasText

        public boolean hasText()
         If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
         provided as input, this field will contain a copy of the text.
         
        string text = 1;
        Specified by:
        hasText in interface QueryResultOrBuilder
        Returns:
        Whether the text field is set.
      • getText

        public String getText()
         If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
         provided as input, this field will contain a copy of the text.
         
        string text = 1;
        Specified by:
        getText in interface QueryResultOrBuilder
        Returns:
        The text.
      • getTextBytes

        public com.google.protobuf.ByteString getTextBytes()
         If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
         provided as input, this field will contain a copy of the text.
         
        string text = 1;
        Specified by:
        getTextBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for text.
      • hasTriggerIntent

        public boolean hasTriggerIntent()
         If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
         input, this field will contain a copy of the intent identifier. Format:
         `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/intents/<Intent ID>`.
         
        string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasTriggerIntent in interface QueryResultOrBuilder
        Returns:
        Whether the triggerIntent field is set.
      • getTriggerIntent

        public String getTriggerIntent()
         If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
         input, this field will contain a copy of the intent identifier. Format:
         `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/intents/<Intent ID>`.
         
        string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTriggerIntent in interface QueryResultOrBuilder
        Returns:
        The triggerIntent.
      • getTriggerIntentBytes

        public com.google.protobuf.ByteString getTriggerIntentBytes()
         If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
         input, this field will contain a copy of the intent identifier. Format:
         `projects/<Project ID>/locations/<Location ID>/agents/<Agent
         ID>/intents/<Intent ID>`.
         
        string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
        Specified by:
        getTriggerIntentBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for triggerIntent.
      • hasTranscript

        public boolean hasTranscript()
         If [natural language speech
         audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
         this field will contain the transcript for the audio.
         
        string transcript = 12;
        Specified by:
        hasTranscript in interface QueryResultOrBuilder
        Returns:
        Whether the transcript field is set.
      • getTranscript

        public String getTranscript()
         If [natural language speech
         audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
         this field will contain the transcript for the audio.
         
        string transcript = 12;
        Specified by:
        getTranscript in interface QueryResultOrBuilder
        Returns:
        The transcript.
      • getTranscriptBytes

        public com.google.protobuf.ByteString getTranscriptBytes()
         If [natural language speech
         audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
         this field will contain the transcript for the audio.
         
        string transcript = 12;
        Specified by:
        getTranscriptBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for transcript.
      • hasTriggerEvent

        public boolean hasTriggerEvent()
         If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
         input, this field will contain the name of the event.
         
        string trigger_event = 14;
        Specified by:
        hasTriggerEvent in interface QueryResultOrBuilder
        Returns:
        Whether the triggerEvent field is set.
      • getTriggerEvent

        public String getTriggerEvent()
         If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
         input, this field will contain the name of the event.
         
        string trigger_event = 14;
        Specified by:
        getTriggerEvent in interface QueryResultOrBuilder
        Returns:
        The triggerEvent.
      • getTriggerEventBytes

        public com.google.protobuf.ByteString getTriggerEventBytes()
         If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
         input, this field will contain the name of the event.
         
        string trigger_event = 14;
        Specified by:
        getTriggerEventBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for triggerEvent.
      • hasDtmf

        public boolean hasDtmf()
         If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as
         input, this field will contain a copy of the
         [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
         
        .google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;
        Specified by:
        hasDtmf in interface QueryResultOrBuilder
        Returns:
        Whether the dtmf field is set.
      • getDtmf

        public DtmfInput getDtmf()
         If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as
         input, this field will contain a copy of the
         [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
         
        .google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;
        Specified by:
        getDtmf in interface QueryResultOrBuilder
        Returns:
        The dtmf.
      • getDtmfOrBuilder

        public DtmfInputOrBuilder getDtmfOrBuilder()
         If a [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as
         input, this field will contain a copy of the
         [DtmfInput][google.cloud.dialogflow.cx.v3.DtmfInput].
         
        .google.cloud.dialogflow.cx.v3.DtmfInput dtmf = 23;
        Specified by:
        getDtmfOrBuilder in interface QueryResultOrBuilder
      • getLanguageCode

        public String getLanguageCode()
         The language that was triggered during intent detection.
         See [Language
         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
         for a list of the currently supported language codes.
         
        string language_code = 2;
        Specified by:
        getLanguageCode in interface QueryResultOrBuilder
        Returns:
        The languageCode.
      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         The language that was triggered during intent detection.
         See [Language
         Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
         for a list of the currently supported language codes.
         
        string language_code = 2;
        Specified by:
        getLanguageCodeBytes in interface QueryResultOrBuilder
        Returns:
        The bytes for languageCode.
      • hasParameters

        public boolean hasParameters()
         The collected [session
         parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
        
         Depending on your protocol or client library language, this is a
         map, associative array, symbol table, dictionary, or JSON object
         composed of a collection of (MapKey, MapValue) pairs:
        
         * MapKey type: string
         * MapKey value: parameter name
         * MapValue type: If parameter's entity type is a composite entity then use
         map, otherwise, depending on the parameter value type, it could be one of
         string, number, boolean, null, list or map.
         * MapValue value: If parameter's entity type is a composite entity then use
         map from composite entity property names to property values, otherwise,
         use parameter value.
         
        .google.protobuf.Struct parameters = 3;
        Specified by:
        hasParameters in interface QueryResultOrBuilder
        Returns:
        Whether the parameters field is set.
      • getParameters

        public com.google.protobuf.Struct getParameters()
         The collected [session
         parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
        
         Depending on your protocol or client library language, this is a
         map, associative array, symbol table, dictionary, or JSON object
         composed of a collection of (MapKey, MapValue) pairs:
        
         * MapKey type: string
         * MapKey value: parameter name
         * MapValue type: If parameter's entity type is a composite entity then use
         map, otherwise, depending on the parameter value type, it could be one of
         string, number, boolean, null, list or map.
         * MapValue value: If parameter's entity type is a composite entity then use
         map from composite entity property names to property values, otherwise,
         use parameter value.
         
        .google.protobuf.Struct parameters = 3;
        Specified by:
        getParameters in interface QueryResultOrBuilder
        Returns:
        The parameters.
      • getParametersOrBuilder

        public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
         The collected [session
         parameters][google.cloud.dialogflow.cx.v3.SessionInfo.parameters].
        
         Depending on your protocol or client library language, this is a
         map, associative array, symbol table, dictionary, or JSON object
         composed of a collection of (MapKey, MapValue) pairs:
        
         * MapKey type: string
         * MapKey value: parameter name
         * MapValue type: If parameter's entity type is a composite entity then use
         map, otherwise, depending on the parameter value type, it could be one of
         string, number, boolean, null, list or map.
         * MapValue value: If parameter's entity type is a composite entity then use
         map from composite entity property names to property values, otherwise,
         use parameter value.
         
        .google.protobuf.Struct parameters = 3;
        Specified by:
        getParametersOrBuilder in interface QueryResultOrBuilder
      • getResponseMessagesList

        public List<ResponseMessage> getResponseMessagesList()
         The list of rich messages returned to the client. Responses vary from
         simple text messages to more sophisticated, structured payloads used
         to drive complex logic.
         
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;
        Specified by:
        getResponseMessagesList in interface QueryResultOrBuilder
      • getResponseMessagesOrBuilderList

        public List<? extends ResponseMessageOrBuilder> getResponseMessagesOrBuilderList()
         The list of rich messages returned to the client. Responses vary from
         simple text messages to more sophisticated, structured payloads used
         to drive complex logic.
         
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;
        Specified by:
        getResponseMessagesOrBuilderList in interface QueryResultOrBuilder
      • getResponseMessagesCount

        public int getResponseMessagesCount()
         The list of rich messages returned to the client. Responses vary from
         simple text messages to more sophisticated, structured payloads used
         to drive complex logic.
         
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;
        Specified by:
        getResponseMessagesCount in interface QueryResultOrBuilder
      • getResponseMessages

        public ResponseMessage getResponseMessages​(int index)
         The list of rich messages returned to the client. Responses vary from
         simple text messages to more sophisticated, structured payloads used
         to drive complex logic.
         
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;
        Specified by:
        getResponseMessages in interface QueryResultOrBuilder
      • getResponseMessagesOrBuilder

        public ResponseMessageOrBuilder getResponseMessagesOrBuilder​(int index)
         The list of rich messages returned to the client. Responses vary from
         simple text messages to more sophisticated, structured payloads used
         to drive complex logic.
         
        repeated .google.cloud.dialogflow.cx.v3.ResponseMessage response_messages = 4;
        Specified by:
        getResponseMessagesOrBuilder in interface QueryResultOrBuilder
      • getWebhookStatusesList

        public List<com.google.rpc.Status> getWebhookStatusesList()
         The list of webhook call status in the order of call sequence.
         
        repeated .google.rpc.Status webhook_statuses = 13;
        Specified by:
        getWebhookStatusesList in interface QueryResultOrBuilder
      • getWebhookStatusesOrBuilderList

        public List<? extends com.google.rpc.StatusOrBuilder> getWebhookStatusesOrBuilderList()
         The list of webhook call status in the order of call sequence.
         
        repeated .google.rpc.Status webhook_statuses = 13;
        Specified by:
        getWebhookStatusesOrBuilderList in interface QueryResultOrBuilder
      • getWebhookStatusesCount

        public int getWebhookStatusesCount()
         The list of webhook call status in the order of call sequence.
         
        repeated .google.rpc.Status webhook_statuses = 13;
        Specified by:
        getWebhookStatusesCount in interface QueryResultOrBuilder
      • getWebhookStatuses

        public com.google.rpc.Status getWebhookStatuses​(int index)
         The list of webhook call status in the order of call sequence.
         
        repeated .google.rpc.Status webhook_statuses = 13;
        Specified by:
        getWebhookStatuses in interface QueryResultOrBuilder
      • getWebhookStatusesOrBuilder

        public com.google.rpc.StatusOrBuilder getWebhookStatusesOrBuilder​(int index)
         The list of webhook call status in the order of call sequence.
         
        repeated .google.rpc.Status webhook_statuses = 13;
        Specified by:
        getWebhookStatusesOrBuilder in interface QueryResultOrBuilder
      • getWebhookPayloadsList

        public List<com.google.protobuf.Struct> getWebhookPayloadsList()
         The list of webhook payload in
         [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
         in the order of call sequence. If some webhook call fails or doesn't return
         any payload, an empty `Struct` would be used instead.
         
        repeated .google.protobuf.Struct webhook_payloads = 6;
        Specified by:
        getWebhookPayloadsList in interface QueryResultOrBuilder
      • getWebhookPayloadsOrBuilderList

        public List<? extends com.google.protobuf.StructOrBuilder> getWebhookPayloadsOrBuilderList()
         The list of webhook payload in
         [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
         in the order of call sequence. If some webhook call fails or doesn't return
         any payload, an empty `Struct` would be used instead.
         
        repeated .google.protobuf.Struct webhook_payloads = 6;
        Specified by:
        getWebhookPayloadsOrBuilderList in interface QueryResultOrBuilder
      • getWebhookPayloadsCount

        public int getWebhookPayloadsCount()
         The list of webhook payload in
         [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
         in the order of call sequence. If some webhook call fails or doesn't return
         any payload, an empty `Struct` would be used instead.
         
        repeated .google.protobuf.Struct webhook_payloads = 6;
        Specified by:
        getWebhookPayloadsCount in interface QueryResultOrBuilder
      • getWebhookPayloads

        public com.google.protobuf.Struct getWebhookPayloads​(int index)
         The list of webhook payload in
         [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
         in the order of call sequence. If some webhook call fails or doesn't return
         any payload, an empty `Struct` would be used instead.
         
        repeated .google.protobuf.Struct webhook_payloads = 6;
        Specified by:
        getWebhookPayloads in interface QueryResultOrBuilder
      • getWebhookPayloadsOrBuilder

        public com.google.protobuf.StructOrBuilder getWebhookPayloadsOrBuilder​(int index)
         The list of webhook payload in
         [WebhookResponse.payload][google.cloud.dialogflow.cx.v3.WebhookResponse.payload],
         in the order of call sequence. If some webhook call fails or doesn't return
         any payload, an empty `Struct` would be used instead.
         
        repeated .google.protobuf.Struct webhook_payloads = 6;
        Specified by:
        getWebhookPayloadsOrBuilder in interface QueryResultOrBuilder
      • hasCurrentPage

        public boolean hasCurrentPage()
         The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all
         fields are filled in this message, including but not limited to `name` and
         `display_name`.
         
        .google.cloud.dialogflow.cx.v3.Page current_page = 7;
        Specified by:
        hasCurrentPage in interface QueryResultOrBuilder
        Returns:
        Whether the currentPage field is set.
      • getCurrentPage

        public Page getCurrentPage()
         The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all
         fields are filled in this message, including but not limited to `name` and
         `display_name`.
         
        .google.cloud.dialogflow.cx.v3.Page current_page = 7;
        Specified by:
        getCurrentPage in interface QueryResultOrBuilder
        Returns:
        The currentPage.
      • getCurrentPageOrBuilder

        public PageOrBuilder getCurrentPageOrBuilder()
         The current [Page][google.cloud.dialogflow.cx.v3.Page]. Some, not all
         fields are filled in this message, including but not limited to `name` and
         `display_name`.
         
        .google.cloud.dialogflow.cx.v3.Page current_page = 7;
        Specified by:
        getCurrentPageOrBuilder in interface QueryResultOrBuilder
      • hasIntent

        @Deprecated
        public boolean hasIntent()
        Deprecated.
        google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=726
         The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the
         conversational query. Some, not all fields are filled in this message,
         including but not limited to: `name` and `display_name`. This field is
         deprecated, please use
         [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
         instead.
         
        .google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];
        Specified by:
        hasIntent in interface QueryResultOrBuilder
        Returns:
        Whether the intent field is set.
      • getIntent

        @Deprecated
        public Intent getIntent()
        Deprecated.
        google.cloud.dialogflow.cx.v3.QueryResult.intent is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=726
         The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the
         conversational query. Some, not all fields are filled in this message,
         including but not limited to: `name` and `display_name`. This field is
         deprecated, please use
         [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
         instead.
         
        .google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];
        Specified by:
        getIntent in interface QueryResultOrBuilder
        Returns:
        The intent.
      • getIntentOrBuilder

        @Deprecated
        public IntentOrBuilder getIntentOrBuilder()
        Deprecated.
         The [Intent][google.cloud.dialogflow.cx.v3.Intent] that matched the
         conversational query. Some, not all fields are filled in this message,
         including but not limited to: `name` and `display_name`. This field is
         deprecated, please use
         [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
         instead.
         
        .google.cloud.dialogflow.cx.v3.Intent intent = 8 [deprecated = true];
        Specified by:
        getIntentOrBuilder in interface QueryResultOrBuilder
      • getIntentDetectionConfidence

        @Deprecated
        public float getIntentDetectionConfidence()
        Deprecated.
        google.cloud.dialogflow.cx.v3.QueryResult.intent_detection_confidence is deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=737
         The intent detection confidence. Values range from 0.0 (completely
         uncertain) to 1.0 (completely certain).
         This value is for informational purpose only and is only used to
         help match the best intent within the classification threshold.
         This value may change for the same end-user expression at any time due to a
         model retraining or change in implementation.
         This field is deprecated, please use
         [QueryResult.match][google.cloud.dialogflow.cx.v3.QueryResult.match]
         instead.
         
        float intent_detection_confidence = 9 [deprecated = true];
        Specified by:
        getIntentDetectionConfidence in interface QueryResultOrBuilder
        Returns:
        The intentDetectionConfidence.
      • hasMatch

        public boolean hasMatch()
         Intent match result, could be an intent or an event.
         
        .google.cloud.dialogflow.cx.v3.Match match = 15;
        Specified by:
        hasMatch in interface QueryResultOrBuilder
        Returns:
        Whether the match field is set.
      • getMatch

        public Match getMatch()
         Intent match result, could be an intent or an event.
         
        .google.cloud.dialogflow.cx.v3.Match match = 15;
        Specified by:
        getMatch in interface QueryResultOrBuilder
        Returns:
        The match.
      • hasDiagnosticInfo

        public boolean hasDiagnosticInfo()
         The free-form diagnostic info. For example, this field could contain
         webhook call latency. The fields of this data can change without notice,
         so you should not write code that depends on its structure.
        
         One of the fields is called "Alternative Matched Intents", which may
         aid with debugging. The following describes these intent results:
        
         - The list is empty if no intent was matched to end-user input.
         - Only intents that are referenced in the currently active flow are
           included.
         - The matched intent is included.
         - Other intents that could have matched end-user input, but did not match
           because they are referenced by intent routes that are out of
           [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
           are included.
         - Other intents referenced by intent routes in scope that matched end-user
           input, but had a lower confidence score.
         
        .google.protobuf.Struct diagnostic_info = 10;
        Specified by:
        hasDiagnosticInfo in interface QueryResultOrBuilder
        Returns:
        Whether the diagnosticInfo field is set.
      • getDiagnosticInfo

        public com.google.protobuf.Struct getDiagnosticInfo()
         The free-form diagnostic info. For example, this field could contain
         webhook call latency. The fields of this data can change without notice,
         so you should not write code that depends on its structure.
        
         One of the fields is called "Alternative Matched Intents", which may
         aid with debugging. The following describes these intent results:
        
         - The list is empty if no intent was matched to end-user input.
         - Only intents that are referenced in the currently active flow are
           included.
         - The matched intent is included.
         - Other intents that could have matched end-user input, but did not match
           because they are referenced by intent routes that are out of
           [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
           are included.
         - Other intents referenced by intent routes in scope that matched end-user
           input, but had a lower confidence score.
         
        .google.protobuf.Struct diagnostic_info = 10;
        Specified by:
        getDiagnosticInfo in interface QueryResultOrBuilder
        Returns:
        The diagnosticInfo.
      • getDiagnosticInfoOrBuilder

        public com.google.protobuf.StructOrBuilder getDiagnosticInfoOrBuilder()
         The free-form diagnostic info. For example, this field could contain
         webhook call latency. The fields of this data can change without notice,
         so you should not write code that depends on its structure.
        
         One of the fields is called "Alternative Matched Intents", which may
         aid with debugging. The following describes these intent results:
        
         - The list is empty if no intent was matched to end-user input.
         - Only intents that are referenced in the currently active flow are
           included.
         - The matched intent is included.
         - Other intents that could have matched end-user input, but did not match
           because they are referenced by intent routes that are out of
           [scope](https://cloud.google.com/dialogflow/cx/docs/concept/handler#scope),
           are included.
         - Other intents referenced by intent routes in scope that matched end-user
           input, but had a lower confidence score.
         
        .google.protobuf.Struct diagnostic_info = 10;
        Specified by:
        getDiagnosticInfoOrBuilder in interface QueryResultOrBuilder
      • hasSentimentAnalysisResult

        public boolean hasSentimentAnalysisResult()
         The sentiment analyss result, which depends on
         [`analyze_query_text_sentiment`]
         [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
         specified in the request.
         
        .google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
        Specified by:
        hasSentimentAnalysisResult in interface QueryResultOrBuilder
        Returns:
        Whether the sentimentAnalysisResult field is set.
      • getSentimentAnalysisResult

        public SentimentAnalysisResult getSentimentAnalysisResult()
         The sentiment analyss result, which depends on
         [`analyze_query_text_sentiment`]
         [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
         specified in the request.
         
        .google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
        Specified by:
        getSentimentAnalysisResult in interface QueryResultOrBuilder
        Returns:
        The sentimentAnalysisResult.
      • getSentimentAnalysisResultOrBuilder

        public SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
         The sentiment analyss result, which depends on
         [`analyze_query_text_sentiment`]
         [google.cloud.dialogflow.cx.v3.QueryParameters.analyze_query_text_sentiment],
         specified in the request.
         
        .google.cloud.dialogflow.cx.v3.SentimentAnalysisResult sentiment_analysis_result = 17;
        Specified by:
        getSentimentAnalysisResultOrBuilder in interface QueryResultOrBuilder
      • 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 QueryResult parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static QueryResult parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

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

        public static QueryResult getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<QueryResult> parser()
      • getParserForType

        public com.google.protobuf.Parser<QueryResult> 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 QueryResult getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder