Method: cursor.projects.locations.subscriptions.cursors.list

Returns all committed cursor information for a subscription.

HTTP request

GET https://{endpoint}/v1/cursor/{parent=projects/*/locations/*/subscriptions/*}/cursors

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The subscription for which to retrieve cursors. Structured like projects/{project_number}/locations/{location}/subscriptions/{subscriptionId}.

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

  • pubsublite.subscriptions.getCursor

Query parameters

Parameters
pageSize

integer

The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned.
pageToken

string

A page token, received from a previous cursors.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to cursors.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for cursors.list

JSON representation 
{
  "partitionCursors": [
    {
      object (PartitionCursor)
    }
  ],
  "nextPageToken": string
}
Fields
partitionCursors[]

object (PartitionCursor)

The partition cursors from this request.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

PartitionCursor

A pair of a Cursor and the partition it is for.

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

string (int64 format)

The partition this is for.
cursor

object (Cursor)

The value of the cursor.