io.nats.client.api

Class MessageInfo

java.lang.Object

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

io.nats.client.api.MessageInfo

public class MessageInfo
extends ApiResponse<MessageInfo>

The MessageInfo class contains information about a JetStream message.

Field Summary

Fields inherited from class io.nats.client.api.ApiResponse

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
MessageInfo(Message msg) Deprecated. This signature was public for unit testing but is no longer used.
MessageInfo(Message msg, java.lang.String streamName, boolean parseDirect) Create a Message Info
MessageInfo(io.nats.client.support.Status status, java.lang.String streamName) Create a Message Info

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Get the message data
@Nullable io.nats.client.impl.Headers	getHeaders() Get the headers
long	getLastSeq() Get the sequence number of the last message in the stream.
long	getNumPending() Amount of pending messages that can be requested with a subsequent batch request.
long	getSeq() Get the message sequence
@Nullable io.nats.client.support.Status	getStatus() Get the Status object.
@Nullable java.lang.String	getStream() Get the name of the stream.
@Nullable java.lang.String	getSubject() Get the message subject
@Nullable java.time.ZonedDateTime	getTime() Get the time the message was received
boolean	isEobStatus() Whether this MessageInfo is a status message and is a direct EOB status
boolean	isErrorStatus() Whether this MessageInfo is a status message and is an error status
boolean	isMessage() Whether this MessageInfo is a regular message
boolean	isStatus() Whether this MessageInfo is a status message
java.lang.String	toString()

Methods inherited from class io.nats.client.api.ApiResponse

getApiErrorCode, getDescription, getError, getErrorCode, getErrorObject, getJv, getType, hasError, throwOnHasError

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageInfo

@Deprecated
public MessageInfo(Message msg)

Deprecated. This signature was public for unit testing but is no longer used.

Create a Message Info

Parameters:

msg - the message

MessageInfo

public MessageInfo(Message msg,
                   java.lang.String streamName,
                   boolean parseDirect)

Create a Message Info

Parameters:

msg - the message

streamName - the stream name if known

parseDirect - true if the object is being created from a direct api call instead of get message

MessageInfo

public MessageInfo(io.nats.client.support.Status status,
                   java.lang.String streamName)

Create a Message Info

Parameters:

status - the status

streamName - the stream name if known

Method Detail

getSubject

public @Nullable java.lang.String getSubject()

Get the message subject

Returns:

the subject

getSeq

public long getSeq()

Get the message sequence

Returns:

the sequence number

getData

public byte[] getData()

Get the message data

Returns:

the data bytes

getTime

public @Nullable java.time.ZonedDateTime getTime()

Get the time the message was received

Returns:

the time

getHeaders

public @Nullable io.nats.client.impl.Headers getHeaders()

Get the headers

Returns:

the headers object or null if there were no headers

getStream

public @Nullable java.lang.String getStream()

Get the name of the stream. Not always set.

Returns:

the stream name or null if the name is not known.

getLastSeq

public long getLastSeq()

Get the sequence number of the last message in the stream. Not always set.

Returns:

the last sequence or -1 if the value is not known.

getNumPending

public long getNumPending()

Amount of pending messages that can be requested with a subsequent batch request.

Returns:

number of pending messages

getStatus

public @Nullable io.nats.client.support.Status getStatus()

Get the Status object. Null if this MessageInfo is not a Status.

Returns:

the status object

isMessage

public boolean isMessage()

Whether this MessageInfo is a regular message

Returns:

true if the MessageInfo is a regular message

isStatus

public boolean isStatus()

Whether this MessageInfo is a status message

Returns:

true if this MessageInfo is a status message

isEobStatus

public boolean isEobStatus()

Whether this MessageInfo is a status message and is a direct EOB status

Returns:

true if this MessageInfo is a status message and is a direct EOB status

isErrorStatus

public boolean isErrorStatus()

Whether this MessageInfo is a status message and is an error status

Returns:

true if this MessageInfo is a status message and is an error status

toString

public java.lang.String toString()

Overrides:

toString in class ApiResponse<MessageInfo>