Method: cursor.projects.locations.subscriptions.commitCursor

Updates the committed cursor.

HTTP request

POST https://{endpoint}/v1/cursor/{subscription=projects/*/locations/*/subscriptions/*}:commitCursor

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
subscription

string

The subscription for which to update the cursor.

Authorization requires the following IAM permission on the specified resource subscription:

  • pubsublite.subscriptions.setCursor

Request body

The request body contains data with the following structure:

JSON representation 
{
  "partition": string,
  "cursor": {
    object (Cursor)
  }
}
Fields
partition

string (int64 format)

The partition for which to update the cursor. Partitions are zero indexed, so partition must be in the range [0, topic.num_partitions).
cursor

object (Cursor)

The new value for the committed cursor.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.