Package org.eclipse.dataspaceconnector.spi

Class ApiErrorDetail

  • public class ApiErrorDetail
extends java.lang.Object
    Define the structure for an API error to be returned to the client

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ApiErrorDetail.Builder  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getInvalidValue()
      The value of the field that caused the error.
      java.lang.String getMessage()
      A description message about the error
      java.lang.String getPath()
      The path of the field that caused the error.
      java.lang.String getType()
      The type of the error occurred

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getMessage

        public java.lang.String getMessage()
        A description message about the error
        Returns:
        the message

      • getType

        public java.lang.String getType()
        The type of the error occurred
        Returns:
        the type

      • getPath

        public java.lang.String getPath()
        The path of the field that caused the error. This value can be null if the error it's not field-specific
        Returns:
        the path

      • getInvalidValue

        public java.lang.String getInvalidValue()
        The value of the field that caused the error. This value can be null if the error it's not field-specific
        Returns:
        the invalid value