Skip to main content
Version: 2.12

Consumer Pause

Consumer paused or resumed.

Subscription Subject

$JS.EVENT.ADVISORY.CONSUMER.PAUSE.{stream}.{consumer}

Where:

  • {stream} is the stream name
  • {consumer} is the consumer name

Event Schema

An Advisory sent when consumer is paused or resumed

typeconst: "io.nats.jetstream.advisory.v1.consumer_pause"required
idstringrequired
Unique correlation ID for this event
timestampstringrequired
The time this event was created in RFC3339 format
streamstringrequired
The name of the Stream the Consumer belongs to
consumerstringrequired
The name of the Consumer that elected a new leader
pausedbooleanrequired
Indicates the consumer is paused
pause_untilstring
When paused the time the consumer will be unpaused, RFC3339 format
domainstring
The domain hosting the Stream and Consumer if configured