io.nats.client.api

Class PublishAck

java.lang.Object

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

io.nats.client.api.PublishAck

public class PublishAck
extends ApiResponse<PublishAck>

PublishAck objects represent a JetStream enabled server acknowledgment from a publish call.

Field Summary

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

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
PublishAck(Message msg) This signature is public for testing purposes and is not intended to be used externally

Method Summary

Modifier and Type	Method and Description
@Nullable java.lang.String	getBatchId() Gets the batch id.
int	getBatchSize() Gets the batch size.
@Nullable java.lang.String	getDomain() Gets the domain of a stream
long	getSeqno() Get the stream sequence number for the corresponding published message.
@NonNull java.lang.String	getStream() Get the name of the stream a published message was stored in.
@Nullable java.lang.String	getVal() Gets a counter value.
boolean	isDuplicate() Gets if the server detected the published message was a duplicate.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PublishAck

public PublishAck(Message msg)
           throws java.io.IOException,
                  JetStreamApiException

This signature is public for testing purposes and is not intended to be used externally

Parameters:

msg - the message containing the Pub Ack Json pub_ack_response.json

Throws:

java.io.IOException - various IO exception such as timeout or interruption

JetStreamApiException - the request had an error related to the request

Method Detail

getSeqno

public long getSeqno()

Get the stream sequence number for the corresponding published message.

Returns:

the sequence number for the stored message.

getStream

public @NonNull java.lang.String getStream()

Get the name of the stream a published message was stored in.

Returns:

the name of the stream.

getDomain

public @Nullable java.lang.String getDomain()

Gets the domain of a stream

Returns:

the domain name

isDuplicate

public boolean isDuplicate()

Gets if the server detected the published message was a duplicate.

Returns:

true if the message is a duplicate, false otherwise.

getVal

public @Nullable java.lang.String getVal()

Gets a counter value. Only available on counter enabled streams

Returns:

the counter value as a string or null

getBatchId

public @Nullable java.lang.String getBatchId()

Gets the batch id. Only populated for batch publishes

Returns:

the batch id

getBatchSize

public int getBatchSize()

Gets the batch size. Only populated for batch publishes.

Returns:

the size of the batch