1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\PubsubLite\Resource;
19
20use Google\Service\PubsubLite\ListPartitionCursorsResponse;
21
22/**
23 * The "cursors" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $pubsubliteService = new Google\Service\PubsubLite(...);
27 *   $cursors = $pubsubliteService->cursors;
28 *  </code>
29 */
30class CursorProjectsLocationsSubscriptionsCursors extends \Google\Service\Resource
31{
32  /**
33   * Returns all committed cursor information for a subscription.
34   * (cursors.listCursorProjectsLocationsSubscriptionsCursors)
35   *
36   * @param string $parent Required. The subscription for which to retrieve
37   * cursors. Structured like `projects/{project_number}/locations/{location}/subs
38   * criptions/{subscription_id}`.
39   * @param array $optParams Optional parameters.
40   *
41   * @opt_param int pageSize The maximum number of cursors to return. The service
42   * may return fewer than this value. If unset or zero, all cursors for the
43   * parent will be returned.
44   * @opt_param string pageToken A page token, received from a previous
45   * `ListPartitionCursors` call. Provide this to retrieve the subsequent page.
46   * When paginating, all other parameters provided to `ListPartitionCursors` must
47   * match the call that provided the page token.
48   * @return ListPartitionCursorsResponse
49   */
50  public function listCursorProjectsLocationsSubscriptionsCursors($parent, $optParams = [])
51  {
52    $params = ['parent' => $parent];
53    $params = array_merge($params, $optParams);
54    return $this->call('list', [$params], ListPartitionCursorsResponse::class);
55  }
56}
57
58// Adding a class alias for backwards compatibility with the previous class name.
59class_alias(CursorProjectsLocationsSubscriptionsCursors::class, 'Google_Service_PubsubLite_Resource_CursorProjectsLocationsSubscriptionsCursors');
60