Optional ack_How long (in nanoseconds) to allow messages to remain un-acknowledged before attempting redelivery
Optional backoffList of durations in nanoseconds format that represents a retry timescale for NaK'd messages or those being normally retried
Optional deliver_Allows push consumers to form a queue group
Where to start consuming messages on the stream
Optional deliver_The subject where the push consumer should be sent the messages
Optional descriptionA short description of the purpose of this consume
Optional durable_A unique name for a durable consumer Set name - for ephemeral consumers, also set idle_heartbeat
Optional filter_Deliver only messages that match the subject filter This is exclusive of filter_subjects
Optional filter_Deliver only messages that match the specified filters. This is exclusive of filter_subject.
Optional flow_For push consumers this will regularly send an empty mess with Status header 100 and a reply subject, consumers must reply to these messages to control the rate of message delivery.
Optional headers_Delivers only the headers of messages in the stream and not the bodies. Additionally, adds Nats-Msg-Size MessageSizeHdr header to indicate the size of the removed payload
Optional idle_If the Consumer is idle for more than this many nanoseconds an empty message with Status header 100 will be sent indicating the consumer is still alive
Optional inactive_Duration that instructs the server to clean up ephemeral consumers that are inactive for that long
Optional max_The maximum number of messages without acknowledgement that can be outstanding, once this limit is reached message delivery will be suspended
Optional max_The largest batch property that may be specified when doing a pull on a Pull Consumer
Optional max_The maximum bytes value that maybe set when dong a pull on a Pull Consumer
Optional max_The number of times a message will be redelivered to consumers if not acknowledged in time
Optional max_The maximum expires value that may be set when doing a pull on a Pull Consumer
Optional max_The number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored
Optional mem_Force the consumer state to be kept in memory rather than inherit the setting from the stream
Optional metadataMetadata field to store additional information about the consumer. Note that
keys starting with _nats are reserved. This feature only supported on servers
2.10.x and better.
Optional nameThe consumer name
Optional num_When set do not inherit the replica count from the stream but specifically set it to this amount.
Optional opt_The sequence from which to start delivery messages. Requires StartSequence
Optional opt_The date time from which to start delivering messages Requires StartTime
Optional pause_Creates a consumer that is initially paused, but will resume at the specified Date and time. Specified as an ISO date time string (Date#toISOString()).
Optional rate_The rate at which messages will be delivered to clients, expressed in bytes per second
How messages are played back to the Consumer
Generated using TypeDoc
The type of acknowledgment required by the Consumer