Package com.io7m.idstore.protocol.user
Record Class IdUResponseError
java.lang.Object
java.lang.Record
com.io7m.idstore.protocol.user.IdUResponseError
- Record Components:
requestId
- The request IDmessage
- The humanly-readable error messageerrorCode
- The error codeattributes
- The error attributesremediatingAction
- The remediating action, if anyblame
- The blame assignment
- All Implemented Interfaces:
com.io7m.hibiscus.api.HBMessageType
,IdProtocolMessageType
,IdUMessageType
,IdUResponseType
,com.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
public record IdUResponseError(UUID requestId, String message, IdErrorCode errorCode, Map<String,String> attributes, Optional<String> remediatingAction, IdUResponseBlame blame)
extends Record
implements IdUResponseType, com.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
An error response.
-
Constructor Summary
ConstructorDescriptionIdUResponseError
(UUID requestId, String message, IdErrorCode errorCode, Map<String, String> attributes, Optional<String> remediatingAction, IdUResponseBlame blame) An error response. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theattributes
record component.blame()
Returns the value of theblame
record component.final boolean
Indicates whether some other object is "equal to" this one.Returns the value of theerrorCode
record component.final int
hashCode()
Returns a hash code value for this object.message()
Returns the value of themessage
record component.Returns the value of theremediatingAction
record component.Returns the value of therequestId
record component.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
IdUResponseError
public IdUResponseError(UUID requestId, String message, IdErrorCode errorCode, Map<String, String> attributes, Optional<String> remediatingAction, IdUResponseBlame blame) An error response.- Parameters:
requestId
- The request IDmessage
- The humanly-readable error messageerrorCode
- The error codeattributes
- The error attributesremediatingAction
- The remediating action, if anyblame
- The blame assignment
-
-
Method Details
-
exception
- Specified by:
exception
in interfacecom.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
- Returns:
- The associated exception, if any
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
requestId
Returns the value of therequestId
record component.- Specified by:
requestId
in interfaceIdUResponseType
- Returns:
- the value of the
requestId
record component
-
message
Returns the value of themessage
record component.- Specified by:
message
in interfacecom.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
- Returns:
- the value of the
message
record component
-
errorCode
Returns the value of theerrorCode
record component.- Specified by:
errorCode
in interfacecom.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
- Returns:
- the value of the
errorCode
record component
-
attributes
Returns the value of theattributes
record component.- Specified by:
attributes
in interfacecom.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
- Returns:
- the value of the
attributes
record component
-
remediatingAction
Returns the value of theremediatingAction
record component.- Specified by:
remediatingAction
in interfacecom.io7m.seltzer.api.SStructuredErrorType<IdErrorCode>
- Returns:
- the value of the
remediatingAction
record component
-
blame
Returns the value of theblame
record component.- Returns:
- the value of the
blame
record component
-