- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- PartitionCursor
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 |
Required. The subscription for which to retrieve cursors. Structured like Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
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 |
A page token, received from a previous When paginating, all other parameters provided to |
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 ( |
Fields | |
---|---|
partitionCursors[] |
The partition cursors from this request. |
nextPageToken |
A token, which can be sent as |
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 ( |
Fields | |
---|---|
partition |
The partition this is for. |
cursor |
The value of the cursor. |