Class GetUtterancesViewRequest

    • Method Detail

      • botName

        public final String botName()

        The name of the bot for which utterance information should be returned.

        Returns:
        The name of the bot for which utterance information should be returned.
      • hasBotVersions

        public final boolean hasBotVersions()
        For responses, this returns true if the service returned a value for the BotVersions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • botVersions

        public final List<String> botVersions()

        An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBotVersions() method.

        Returns:
        An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
      • statusType

        public final StatusType statusType()

        To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.

        If the service returns an enum value that is not available in the current SDK version, statusType will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusTypeAsString().

        Returns:
        To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.
        See Also:
        StatusType
      • statusTypeAsString

        public final String statusTypeAsString()

        To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.

        If the service returns an enum value that is not available in the current SDK version, statusType will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusTypeAsString().

        Returns:
        To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.
        See Also:
        StatusType
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object