📄 Source: CursorProjectsLocationsSubscriptionsCursors.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\PubsubLite\Resource;
use Google\Service\PubsubLite\ListPartitionCursorsResponse;
/**
* The "cursors" collection of methods.
* Typical usage is:
* <code>
* $pubsubliteService = new Google\Service\PubsubLite(...);
* $cursors = $pubsubliteService->cursor_projects_locations_subscriptions_cursors;
* </code>
*/
class CursorProjectsLocationsSubscriptionsCursors extends \Google\Service\Resource
{
/**
* Returns all committed cursor information for a subscription.
* (cursors.listCursorProjectsLocationsSubscriptionsCursors)
*
* @param string $parent Required. The subscription for which to retrieve
* cursors. Structured like `projects/{project_number}/locations/{location}/subs
* criptions/{subscription_id}`.
* @param array $optParams Optional parameters.
*
* @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 ListPartitionCursorsResponse
* @throws \Google\Service\Exception
*/
public function listCursorProjectsLocationsSubscriptionsCursors($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListPartitionCursorsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CursorProjectsLocationsSubscriptionsCursors::class, 'Google_Service_PubsubLite_Resource_CursorProjectsLocationsSubscriptionsCursors');
← Back