Documentation

Google_Service_PubsubLite_Resource_CursorProjectsLocationsSubscriptionsCursors extends Google_Service_Resource
in package

The "cursors" collection of methods.

Typical usage is: $pubsubliteService = new Google_Service_PubsubLite(...); $cursors = $pubsubliteService->cursors;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
listCursorProjectsLocationsSubscriptionsCursors()  : Google_Service_PubsubLite_ListPartitionCursorsResponse
Returns all committed cursor information for a subscription.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

listCursorProjectsLocationsSubscriptionsCursors()

Returns all committed cursor information for a subscription.

public listCursorProjectsLocationsSubscriptionsCursors(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PubsubLite_ListPartitionCursorsResponse

(cursors.listCursorProjectsLocationsSubscriptionsCursors)

Parameters
$parent : string

Required. The subscription for which to retrieve cursors. Structured like projects/{project_number}/locations/{location}/subs criptions/{subscription_id}.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int 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.

opt_param

string pageToken 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.

Return values
Google_Service_PubsubLite_ListPartitionCursorsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results