Type Alias ConsumerUpdateConfig

ConsumerUpdateConfig: PriorityGroups & {
    ack_wait?: Nanos;
    backoff?: Nanos[];
    deliver_subject?: string;
    description?: string;
    filter_subject?: string;
    filter_subjects?: string[];
    headers_only?: boolean;
    inactive_threshold?: Nanos;
    max_ack_pending?: number;
    max_batch?: number;
    max_bytes?: number;
    max_deliver?: number;
    max_expires?: Nanos;
    max_waiting?: number;
    mem_storage?: boolean;
    metadata?: Record<string, string>;
    num_replicas?: number;
}

Type declaration

  • Optionalack_wait?: Nanos

    How long (in nanoseconds) to allow messages to remain un-acknowledged before attempting redelivery

  • Optionalbackoff?: Nanos[]

    List of durations in nanoseconds that represents a retry timescale for the redelivery of messages

  • Optionaldeliver_subject?: string

    The subject where the push consumer should be sent the messages

  • Optionaldescription?: string

    A short description of the purpose of this consume

  • Optionalfilter_subject?: string

    Deliver only messages that match the subject filter This is exclusive of filter_subjects

  • Optionalfilter_subjects?: string[]

    Deliver only messages that match the specified filters. This is exclusive of filter_subject.

  • Optionalheaders_only?: boolean

    Delivers only the headers of messages in the stream and not the bodies. Additionally, adds Nats-Msg-Size JsHeaders#MessageSizeHdr header to indicate the size of the removed payload

  • Optionalinactive_threshold?: Nanos

    Duration that instructs the server to clean up ephemeral consumers that are inactive for the specified time in nanoseconds

  • Optionalmax_ack_pending?: number

    The maximum number of messages without acknowledgement that can be outstanding, once this limit is reached message delivery will be suspended

  • Optionalmax_batch?: number

    The largest batch property that may be specified when doing a pull on a Pull Consumer

  • Optionalmax_bytes?: number

    The maximum bytes value that maybe set when dong a pull on a Pull Consumer

  • Optionalmax_deliver?: number

    The maximum number of times a message will be delivered to consumers if not acknowledged in time. Default is -1 (will redeliver until acknowledged).

  • Optionalmax_expires?: Nanos

    The maximum expires value that may be set when doing a pull on a Pull Consumer expressed in nanoseconds.

  • Optionalmax_waiting?: number

    The number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored

  • Optionalmem_storage?: boolean

    Force the consumer state to be kept in memory rather than inherit the setting from the stream

  • Optionalmetadata?: Record<string, string>

    Metadata 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.

  • Optionalnum_replicas?: number

    When set do not inherit the replica count from the stream but specifically set it to this amount.

Settings

Member Visibility