Skip to main content

Cursor-commit-result

The result of single cursor commit. Holds a cursor itself and a result value.

cursor objectrequired
event_typestringrequired

The name of the event type this partition's events belong to.

Possible values: non-empty

cursor_tokenstringrequired

An opaque value defined by the server.

Possible values: non-empty

partitionstringrequired

Id of the partition pointed to by this cursor.

Possible values: non-empty

offsetstringrequired

Offset of the event being pointed to. Note that if you want to specify beginning position of a stream with first event at offset N, you should specify offset N-1. This applies in cases when you create new subscription or reset subscription offsets. Also for stream start offsets one can use two special values: - begin - read from the oldest available event. - end - read from the most recent offset.

Possible values: non-empty

resultstringrequired

The result of cursor commit. - committed: cursor was successfully committed - outdated: there already was more recent (or the same) cursor committed, so the current one was not committed as it is outdated

Possible values: non-empty

Cursor-commit-result
{
"cursor": {
"event_type": "string",
"cursor_token": "string",
"partition": "string",
"offset": "string"
},
"result": "string"
}