io.nats.client.api

Class PurgeResponse

java.lang.Object

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

io.nats.client.api.PurgeResponse

public class PurgeResponse
extends ApiResponse<PurgeResponse>

Field Summary

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

json, NO_TYPE

Constructor Summary

Constructors

Constructor and Description
PurgeResponse(Message msg)

Method Summary

Modifier and Type	Method and Description
long	getPurged() Returns the number of items purged from the stream
int	getPurgedCount() Deprecated. This method is replaced since the purged value is a long value, not an int value See getPurged() instead.
boolean	isSuccess() Returns true if the server was able to purge the stream
java.lang.String	toString()

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PurgeResponse

public PurgeResponse(Message msg)

Method Detail

isSuccess

public boolean isSuccess()

Returns true if the server was able to purge the stream

Returns:

the result flag

getPurgedCount

@Deprecated
public int getPurgedCount()

Deprecated. This method is replaced since the purged value is a long value, not an int value See getPurged() instead.

Returns the number of items purged from the stream

Returns:

the count

getPurged

public long getPurged()

Returns the number of items purged from the stream

Returns:

the count

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object