Class ErrorObject

    • Method Detail

      • errorMessage

        public final String errorMessage()

        A human-readable error message.

        Returns:
        A human-readable error message.
      • errorType

        public final String errorType()

        The error type.

        Returns:
        The error type.
      • errorData

        public final String errorData()

        Machine-readable error data.

        Returns:
        Machine-readable error data.
      • hasStackTrace

        public final boolean hasStackTrace()
        For responses, this returns true if the service returned a value for the StackTrace 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.
      • stackTrace

        public final List<String> stackTrace()

        Stack trace information for the error.

        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 hasStackTrace() method.

        Returns:
        Stack trace information for the error.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)