Class Error


  • public class Error
    extends Object
    On error, the API consumer will receive an HTTP response with a HTTP Status Code of 4xx or 5xx and a Content-Type of application/problem+json.
    • Constructor Detail

      • Error

        public Error()
    • Method Detail

      • title

        public Error title​(String title)
        Human readable high level error description.
        Parameters:
        title - String
        Returns:
        Error
      • getTitle

        public String getTitle()
        Human readable high level error description. maximum: 255
        Returns:
        title
      • setTitle

        public void setTitle​(String title)
        Human readable high level error description.
        Parameters:
        title - String
      • status

        public Error status​(Integer status)
        The numeric HTTP Status Code, e.g. 404
        Parameters:
        status - Integer
        Returns:
        Error
      • getStatus

        public Integer getStatus()
        The numeric HTTP Status Code, e.g. 404
        Returns:
        status
      • setStatus

        public void setStatus​(Integer status)
        The numeric HTTP Status Code, e.g. 404
        Parameters:
        status - Integer
      • detail

        public Error detail​(String detail)
        Human readable detailed error description.
        Parameters:
        detail - String
        Returns:
        Error
      • getDetail

        public String getDetail()
        Human readable detailed error description. maximum: 255
        Returns:
        detail
      • setDetail

        public void setDetail​(String detail)
        Human readable detailed error description.
        Parameters:
        detail - String
      • type

        public Error type​(Error.TypeEnum type)
        Identifies the type of error.
        Parameters:
        type - TypeEnum
        Returns:
        Error
      • getType

        public Error.TypeEnum getType()
        Identifies the type of error.
        Returns:
        type
      • setType

        public void setType​(Error.TypeEnum type)
        Identifies the type of error.
        Parameters:
        type - TypeEnum
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object