io.nats.client.api

Class ApiResponse<T>

java.lang.Object

io.nats.client.api.ApiResponse<T>

Type Parameters:

T - the success response class

Direct Known Subclasses:

AccountStatistics, ConsumerInfo, ConsumerPauseResponse, MessageInfo, PublishAck, PurgeResponse, StreamInfo, SuccessApiResponse

public abstract class ApiResponse<T>
extends java.lang.Object

ApiResponse is the base class for all api responses from the server

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_TYPE A constant for a response without a type
static java.lang.String	PARSE_ERROR_TYPE a constant for a response that errors while parsing

Constructor Summary

Constructors

Constructor and Description
ApiResponse() Construct an empty ApiResponse
ApiResponse(Error error) Construct an ApiResponse from an error object
ApiResponse(io.nats.client.support.JsonValue jsonValue) Construct an ApiResponse from a JsonValue
ApiResponse(Message msg) construct an ApiResponse from a message

Method Summary

Modifier and Type	Method and Description
int	getApiErrorCode() The api error code from the server
@Nullable java.lang.String	getDescription() Get the error description
@Nullable java.lang.String	getError() Get the error object string
int	getErrorCode() The request error code from the server
@Nullable Error	getErrorObject() Get the error object
@Nullable io.nats.client.support.JsonValue	getJv() Get the JsonValue used to make this object
@Nullable java.lang.String	getType() The type of the response object
boolean	hasError() Does the response have an error
T	throwOnHasError() throw an Exception if the response had an error
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_TYPE

public static final java.lang.String NO_TYPE

A constant for a response without a type

See Also:

Constant Field Values

PARSE_ERROR_TYPE

public static final java.lang.String PARSE_ERROR_TYPE

a constant for a response that errors while parsing

See Also:

Constant Field Values

Constructor Detail

ApiResponse

public ApiResponse(Message msg)

construct an ApiResponse from a message

Parameters:

msg - the message

ApiResponse

public ApiResponse(io.nats.client.support.JsonValue jsonValue)

Construct an ApiResponse from a JsonValue

Parameters:

jsonValue - the value

ApiResponse

public ApiResponse()

Construct an empty ApiResponse

ApiResponse

public ApiResponse(Error error)

Construct an ApiResponse from an error object

Parameters:

error - the error object

Method Detail

throwOnHasError

public T throwOnHasError()
                  throws JetStreamApiException

throw an Exception if the response had an error

Returns:

the ApiResponse if not an error

Throws:

JetStreamApiException - if the response had an error

getJv

public @Nullable io.nats.client.support.JsonValue getJv()

Get the JsonValue used to make this object

Returns:

the value

hasError

public boolean hasError()

Does the response have an error

Returns:

true if the response has an error

getType

public @Nullable java.lang.String getType()

The type of the response object

Returns:

the type

getErrorCode

public int getErrorCode()

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 @Nullable java.lang.String getDescription()

Get the error description

Returns:

the description if the response is an error

getError

public @Nullable java.lang.String getError()

Get the error object string

Returns:

the error object string if the response is an error

getErrorObject

public @Nullable Error getErrorObject()

Get the error object

Returns:

the error object if the response is an error

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object