Package io.stargate.sgv2.api.common.exception.model.dto

Record Class ApiError

java.lang.Object

java.lang.Record

io.stargate.sgv2.api.common.exception.model.dto.ApiError

Record Components:

description - A human-readable description of the error state.

code - The internal number referencing the error state.

grpcStatus - Status of a GRPC call, if this fails.

internalTxId - The internal tracking number of the request.

public record ApiError(String description, int code, String grpcStatus, String internalTxId)
extends Record

Record for representing the API error.

Constructor Summary

Constructors

Constructor	Description
ApiError(String description)
ApiError(String description, int code)
ApiError(String description, int code, String grpcStatus)
ApiError(String description, int code, String grpcStatus, String internalTxId)	Creates an instance of a ApiError record class.

Method Summary

Modifier and Type	Method	Description
int	code()	Returns the value of the code record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	grpcStatus()	Returns the value of the grpcStatus record component.
final int	hashCode()	Returns a hash code value for this object.
String	internalTxId()	Returns the value of the internalTxId 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

ApiError

public ApiError(String description)

ApiError

public ApiError(String description,
 int code)

ApiError

public ApiError(String description,
 int code,
 String grpcStatus)

ApiError

public ApiError(String description,
 int code,
 String grpcStatus,
 String internalTxId)

Creates an instance of a ApiError record class.

Parameters:

description - the value for the description record component

code - the value for the code record component

grpcStatus - the value for the grpcStatus record component

internalTxId - the value for the internalTxId 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

code

public int code()

Returns the value of the code record component.

Returns:

the value of the code record component

grpcStatus

public String grpcStatus()

Returns the value of the grpcStatus record component.

Returns:

the value of the grpcStatus record component

internalTxId

public String internalTxId()

Returns the value of the internalTxId record component.

Returns:

the value of the internalTxId record component