io.nats.client.api

Class Error

java.lang.Object

io.nats.client.api.Error

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class Error
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

Error returned from an api request.

Field Summary

Fields

Modifier and Type	Field and Description
static @NonNull Error	JsBadRequestErr Error representing 400 / 10003 / "bad request"
static @NonNull Error	JsNoMessageFoundErr Error representing 404 / 10037 / "no message found"
static int	NOT_SET represents an error code that was not set / provided

Method Summary

Modifier and Type	Method and Description
static @NonNull Error	convert(io.nats.client.support.Status status) Convert a status to an Error object.
int	getApiErrorCode() The api error code from the server
int	getCode() The request error code from the server
@NonNull java.lang.String	getDescription() Get the error description
@NonNull java.lang.String	toJson()
@NonNull io.nats.client.support.JsonValue	toJsonValue()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize

Field Detail

NOT_SET

public static final int NOT_SET

represents an error code that was not set / provided

See Also:

Constant Field Values

JsBadRequestErr

public static final @NonNull Error JsBadRequestErr

Error representing 400 / 10003 / "bad request"

JsNoMessageFoundErr

public static final @NonNull Error JsNoMessageFoundErr

Error representing 404 / 10037 / "no message found"

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

toJsonValue

public @NonNull io.nats.client.support.JsonValue toJsonValue()

Specified by:

toJsonValue in interface io.nats.client.support.JsonSerializable

getCode

public int getCode()

The request error code from the server

Returns:

the code

getApiErrorCode

public int getApiErrorCode()

The api error code from the server

Returns:

the code

getDescription

public @NonNull java.lang.String getDescription()

Get the error description

Returns:

the description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

convert

public static @NonNull Error convert(io.nats.client.support.Status status)

Convert a status to an Error object. Only some status are supported, otherwise a generic error is returned

Parameters:

status - the status

Returns:

the error