io.nats.client.api

Class ConsumerPauseResponse

java.lang.Object

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

io.nats.client.api.ConsumerPauseResponse

public class ConsumerPauseResponse
extends ApiResponse<ConsumerPauseResponse>

The response for a ConsumerPauseRequest

Field Summary

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

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
ConsumerPauseResponse(Message msg) Construct a ConsumerPauseResponse instance from a message

Method Summary

Modifier and Type	Method and Description
@Nullable java.time.Duration	getPauseRemaining() Returns how much time is remaining for this consumer to be paused
@Nullable java.time.ZonedDateTime	getPauseUntil() Returns the time until the consumer is paused
boolean	isPaused() Returns true if the consumer was paused

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

ConsumerPauseResponse

public ConsumerPauseResponse(Message msg)

Construct a ConsumerPauseResponse instance from a message

Parameters:

msg - the message

Method Detail

isPaused

public boolean isPaused()

Returns true if the consumer was paused

Returns:

whether the consumer is paused

getPauseUntil

public @Nullable java.time.ZonedDateTime getPauseUntil()

Returns the time until the consumer is paused

Returns:

pause until time

getPauseRemaining

public @Nullable java.time.Duration getPauseRemaining()

Returns how much time is remaining for this consumer to be paused

Returns:

remaining paused time