Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateCursorDetails

Object used to create a cursor to consume messages in a stream.

Enumerations

Properties

Functions

Properties

Optional offset

offset: undefined | number

The offset to consume from if the cursor type is AT_OFFSET or AFTER_OFFSET. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

partition

partition: string

The partition to get messages from.

Optional time

time: Date

The time to consume from if the cursor type is AT_TIME, expressed in RFC 3339 timestamp format.

type

type: Type

The type of cursor, which determines the starting point from which the stream will be consumed:

- `AFTER_OFFSET:` The partition position immediately following the offset you specify. (Offsets are assigned when you successfully append a message to a partition in a stream.) - `AT_OFFSET:` The exact partition position indicated by the offset you specify. - `AT_TIME:` A specific point in time. - `LATEST:` The most recent message in the partition that was added after the cursor was created. - `TRIM_HORIZON:` The oldest message in the partition that is within the retention period window.

Functions

getDeserializedJsonObj

getJsonObj