Skip to main content

cursors

Creates, updates, deletes, gets or lists a cursors resource.

Overview

Namecursors
TypeResource
Idgoogle.pubsublite.cursors

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
cursorobjectThe value of the cursor. (id: Cursor)
partitionstring (int64)The partition this is for.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
cursor_projects_locations_subscriptions_cursors_listselectprojectsId, locationsId, subscriptionsIdpageSize, pageTokenReturns all committed cursor information for a subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring
subscriptionsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Returns all committed cursor information for a subscription.

SELECT
cursor,
partition
FROM google.pubsublite.cursors
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND subscriptionsId = '{{ subscriptionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';