Pub/Sub Lite API . cursor . projects . locations . subscriptions . cursors

Instance Methods

close()

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns all committed cursor information for a subscription.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns all committed cursor information for a subscription.

Args:
  parent: string, Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`. (required)
  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 `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListPartitionCursors
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "partitionCursors": [ # The partition cursors from this request.
    { # A pair of a Cursor and the partition it is for.
      "cursor": { # A cursor that describes the position of a message within a topic partition. # The value of the cursor.
        "offset": "A String", # The offset of a message within a topic partition. Must be greater than or equal 0.
      },
      "partition": "A String", # The partition this is for.
    },
  ],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.