Record Class CJ1ResponseError

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.json.internal.CJ1ResponseError

Record Components:

requestId - The request ID

message - The error summary

errorCode - The error kind

attributes - The error attributes

remediatingAction - The remediating action, if any

blame - The blame assignment

extras - The extra error messages

All Implemented Interfaces:

CJ1MessageType, CJ1ResponseType, CJ1ValueType

public record CJ1ResponseError(UUID requestId, String message, CAErrorCode errorCode, Map<String,String> attributes, Optional<String> remediatingAction, CJ1ResponseBlame blame, List<CJ1StructuredError> extras)
extends Record
implements CJ1ResponseType

A command failed.

Constructor Summary

Constructors

Constructor	Description
CJ1ResponseError(UUID requestId, String message, CAErrorCode errorCode, Map<String,String> attributes, Optional<String> remediatingAction, CJ1ResponseBlame blame, List<CJ1StructuredError> extras)	Creates an instance of a CJ1ResponseError record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
CJ1ResponseBlame	blame()	Returns the value of the blame record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
CAErrorCode	errorCode()	Returns the value of the errorCode record component.
List<CJ1StructuredError>	extras()	Returns the value of the extras record component.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
Optional<String>	remediatingAction()	Returns the value of the remediatingAction record component.
UUID	requestId()	Returns the value of the requestId record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CJ1ResponseError

public CJ1ResponseError(UUID requestId,
 String message,
 CAErrorCode errorCode,
 Map<String,String> attributes,
 Optional<String> remediatingAction,
 CJ1ResponseBlame blame,
 List<CJ1StructuredError> extras)

Creates an instance of a CJ1ResponseError record class.

Parameters:

requestId - the value for the requestId record component

message - the value for the message record component

errorCode - the value for the errorCode record component

attributes - the value for the attributes record component

remediatingAction - the value for the remediatingAction record component

blame - the value for the blame record component

extras - the value for the extras record component

Method Details

toString

public final String 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.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

requestId

public UUID requestId()

Returns the value of the requestId record component.

Returns:

the value of the requestId record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

errorCode

public CAErrorCode errorCode()

Returns the value of the errorCode record component.

Returns:

the value of the errorCode record component

attributes

public Map<String,String> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

remediatingAction

public Optional<String> remediatingAction()

Returns the value of the remediatingAction record component.

Returns:

the value of the remediatingAction record component

blame

public CJ1ResponseBlame blame()

Returns the value of the blame record component.

Returns:

the value of the blame record component

extras

public List<CJ1StructuredError> extras()

Returns the value of the extras record component.

Returns:

the value of the extras record component