io.nats.client.api

Class AccountStatistics

java.lang.Object

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

io.nats.client.api.AccountStatistics

public class AccountStatistics
extends ApiResponse<AccountStatistics>

The JetStream Account Statistics

Field Summary

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

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
AccountStatistics(Message msg) Construct an AccountStatistics

Method Summary

Modifier and Type	Method and Description
@NonNull ApiStats	getApi() Gets the account api stats
long	getConsumers() Gets the number of consumers used by the JetStream deployment.
@Nullable java.lang.String	getDomain() Gets the account domain.
AccountLimits	getLimits() Gets the Account Limits object.
long	getMemory() Gets the amount of memory storage used by the JetStream deployment.
long	getReservedMemory() Bytes that is reserved for memory usage by this account on the server
long	getReservedStorage() Bytes that is reserved for disk usage by this account on the server
long	getStorage() Gets the amount of file storage used by the JetStream deployment.
long	getStreams() Gets the number of streams used by the JetStream deployment.
@NonNull java.util.Map<java.lang.String,AccountTier>	getTiers() Gets the map of the Account Tiers by tier name.

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

AccountStatistics

public AccountStatistics(Message msg)

Construct an AccountStatistics

Parameters:

msg - the api response message

Method Detail

getMemory

public long getMemory()

Gets the amount of memory storage used by the JetStream deployment. If the account has tiers, this will represent a rollup.

Returns:

bytes

getStorage

public long getStorage()

Gets the amount of file storage used by the JetStream deployment. If the account has tiers, this will represent a rollup.

Returns:

bytes

getReservedMemory

public long getReservedMemory()

Bytes that is reserved for memory usage by this account on the server

Returns:

the memory usage in bytes

getReservedStorage

public long getReservedStorage()

Bytes that is reserved for disk usage by this account on the server

Returns:

the disk usage in bytes

getStreams

public long getStreams()

Gets the number of streams used by the JetStream deployment. If the account has tiers, this will represent a rollup.

Returns:

stream maximum count

getConsumers

public long getConsumers()

Gets the number of consumers used by the JetStream deployment. If the account has tiers, this will represent a rollup.

Returns:

consumer maximum count

getLimits

public AccountLimits getLimits()

Gets the Account Limits object. If the account has tiers, the object will be present but all values will be zero. See the Account Limits for the specific tier.

Returns:

the AccountLimits object

getDomain

public @Nullable java.lang.String getDomain()

Gets the account domain. May be null

Returns:

the domain

getApi

public @NonNull ApiStats getApi()

Gets the account api stats

Returns:

the ApiStats object

getTiers

public @NonNull java.util.Map<java.lang.String,AccountTier> getTiers()

Gets the map of the Account Tiers by tier name. May be empty, but never null.

Returns:

the map