Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateGroupCursorDetails

Object used to create a group cursor.

Properties

Optional commitOnGet

commitOnGet: undefined | false | true

When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false. If disabled, a consumer must manually commit their cursors.

groupName

groupName: string

Name of the consumer group.

Optional instanceName

instanceName: undefined | string

A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used.

Optional time

time: Date

The time to consume from if type is AT_TIME.

Optional timeoutInMs

timeoutInMs: undefined | number

The amount of a consumer instance inactivity time, before partition reservations are released. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

type

type: Type

The type of the cursor. This value is only used when the group is created.

Functions

getDeserializedJsonObj

getJsonObj