Type Alias ConsumerInfo

ConsumerInfo: {
    ack_floor: SequenceInfo;
    cluster?: ClusterInfo;
    config: ConsumerConfig;
    created: string;
    delivered: SequenceInfo;
    name: string;
    num_ack_pending: number;
    num_pending: number;
    num_redelivered: number;
    num_waiting: number;
    pause_remaining: Nanos;
    paused?: boolean;
    push_bound: boolean;
    stream_name: string;
    ts?: string;
}

Type declaration

  • ack_floor: SequenceInfo

    The highest contiguous acknowledged message

  • Optionalcluster?: ClusterInfo

    The cluster where the consumer is defined

  • config: ConsumerConfig

    The consumer configuration

  • created: string

    The ISO timestamp when the Consumer was created

  • delivered: SequenceInfo

    The last message delivered from this Consumer

  • name: string

    A unique name for the consumer, either machine generated or the durable name

  • num_ack_pending: number

    The number of messages pending acknowledgement but yet to acknowledged by the client.

  • num_pending: number

    The number of messages left unconsumed in this Consumer

  • num_redelivered: number

    The number of redeliveries that have been performed

  • num_waiting: number

    The number of pull consumers waiting for messages

  • pause_remaining: Nanos

    If the consumer was paused with a resume date, this field specifies the amount of time in nanoseconds remaining until the consumer will be automatically resumed. This field is only available on servers 2.11.x or better

  • Optionalpaused?: boolean

    Set to true if the consumer is paused. This field is only available on servers 2.11.x or better

  • push_bound: boolean

    Indicates if any client is connected and receiving messages from a push consumer

  • stream_name: string

    The stream hosting the consumer

  • Optionalts?: string

    The ISO timestamp when the ConsumerInfo was generated. This field is only available on servers 2.10.x or better

Settings

Member Visibility