Class ErrorEntity


  • public final class ErrorEntity
    extends Object
    Body of the error response returned from the API.
    • Constructor Detail

      • ErrorEntity

        public ErrorEntity()
    • Method Detail

      • extendedCode

        public String extendedCode()
        Get the extendedCode property: Type of error.
        Returns:
        the extendedCode value.
      • withExtendedCode

        public ErrorEntity withExtendedCode​(String extendedCode)
        Set the extendedCode property: Type of error.
        Parameters:
        extendedCode - the extendedCode value to set.
        Returns:
        the ErrorEntity object itself.
      • messageTemplate

        public String messageTemplate()
        Get the messageTemplate property: Message template.
        Returns:
        the messageTemplate value.
      • withMessageTemplate

        public ErrorEntity withMessageTemplate​(String messageTemplate)
        Set the messageTemplate property: Message template.
        Parameters:
        messageTemplate - the messageTemplate value to set.
        Returns:
        the ErrorEntity object itself.
      • parameters

        public List<String> parameters()
        Get the parameters property: Parameters for the template.
        Returns:
        the parameters value.
      • withParameters

        public ErrorEntity withParameters​(List<String> parameters)
        Set the parameters property: Parameters for the template.
        Parameters:
        parameters - the parameters value to set.
        Returns:
        the ErrorEntity object itself.
      • innerErrors

        public List<ErrorEntity> innerErrors()
        Get the innerErrors property: Inner errors.
        Returns:
        the innerErrors value.
      • withInnerErrors

        public ErrorEntity withInnerErrors​(List<ErrorEntity> innerErrors)
        Set the innerErrors property: Inner errors.
        Parameters:
        innerErrors - the innerErrors value to set.
        Returns:
        the ErrorEntity object itself.
      • details

        public List<ErrorEntity> details()
        Get the details property: Error Details.
        Returns:
        the details value.
      • withDetails

        public ErrorEntity withDetails​(List<ErrorEntity> details)
        Set the details property: Error Details.
        Parameters:
        details - the details value to set.
        Returns:
        the ErrorEntity object itself.
      • target

        public String target()
        Get the target property: The error target.
        Returns:
        the target value.
      • withTarget

        public ErrorEntity withTarget​(String target)
        Set the target property: The error target.
        Parameters:
        target - the target value to set.
        Returns:
        the ErrorEntity object itself.
      • code

        public String code()
        Get the code property: Basic error code.
        Returns:
        the code value.
      • withCode

        public ErrorEntity withCode​(String code)
        Set the code property: Basic error code.
        Parameters:
        code - the code value to set.
        Returns:
        the ErrorEntity object itself.
      • message

        public String message()
        Get the message property: Any details of the error.
        Returns:
        the message value.
      • withMessage

        public ErrorEntity withMessage​(String message)
        Set the message property: Any details of the error.
        Parameters:
        message - the message value to set.
        Returns:
        the ErrorEntity object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.