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>

Field Summary

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

jv, NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
ConsumerPauseResponse(Message msg)

Method Summary

Modifier and Type	Method and Description
java.time.Duration	getPauseRemaining() Returns how much time is remaining for this consumer to be paused
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, parseMessage, throwOnHasError, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerPauseResponse

public ConsumerPauseResponse(Message msg)

Method Detail

isPaused

public boolean isPaused()

Returns true if the consumer was paused

Returns:

whether the consumer is paused

getPauseUntil

public java.time.ZonedDateTime getPauseUntil()

Returns the time until the consumer is paused

Returns:

pause until time

getPauseRemaining

public java.time.Duration getPauseRemaining()

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

Returns:

remaining paused time