Class FailureDetailsLogInfo


  • public class FailureDetailsLogInfo
    extends java.lang.Object
    Provides details about a failure
    • Field Detail

      • userFriendlyMessage

        protected final java.lang.String userFriendlyMessage
      • technicalErrorMessage

        protected final java.lang.String technicalErrorMessage
    • Constructor Detail

      • FailureDetailsLogInfo

        public FailureDetailsLogInfo​(java.lang.String userFriendlyMessage,
                                     java.lang.String technicalErrorMessage)
        Provides details about a failure

        Use newBuilder() to create instances of this class without specifying values for all optional fields.

        Parameters:
        userFriendlyMessage - A user friendly explanation of the error. Might be missing due to historical data gap.
        technicalErrorMessage - A technical explanation of the error. This is relevant for some errors.
      • FailureDetailsLogInfo

        public FailureDetailsLogInfo()
        Provides details about a failure

        The default values for unset fields will be used.

    • Method Detail

      • getUserFriendlyMessage

        public java.lang.String getUserFriendlyMessage()
        A user friendly explanation of the error. Might be missing due to historical data gap.
        Returns:
        value for this field, or null if not present.
      • getTechnicalErrorMessage

        public java.lang.String getTechnicalErrorMessage()
        A technical explanation of the error. This is relevant for some errors.
        Returns:
        value for this field, or null if not present.
      • newBuilder

        public static FailureDetailsLogInfo.Builder newBuilder()
        Returns a new builder for creating an instance of this class.
        Returns:
        builder for this class.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object