Type Alias HeartbeatRequest

Heartbeat request payload.

type HeartbeatRequest = {
    generationId: number;
    groupId: string;
    groupInstanceId?: string | null;
    memberId: string;
    taggedFields?: readonly TaggedField[];
}

Index

Properties

generationId groupId groupInstanceId? memberId taggedFields?

Properties

`Readonly`generationId

generationId: number

The generation ID from the most recent JoinGroup response.

`Readonly`groupId

groupId: string

The group ID.

`Optional` `Readonly`groupInstanceId

groupInstanceId?: string | null

The group instance ID for static membership (v3+). Null if not static.

`Readonly`memberId

memberId: string

This member's member ID.

`Optional` `Readonly`taggedFields

taggedFields?: readonly TaggedField[]

Tagged fields (v4+).