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\Spanner\Resource;
19
20use Google\Service\Spanner\ListOperationsResponse;
21use Google\Service\Spanner\Operation;
22use Google\Service\Spanner\SpannerEmpty;
23
24/**
25 * The "operations" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $spannerService = new Google\Service\Spanner(...);
29 *   $operations = $spannerService->operations;
30 *  </code>
31 */
32class ProjectsInstancesOperations extends \Google\Service\Resource
33{
34  /**
35   * Starts asynchronous cancellation on a long-running operation. The server
36   * makes a best effort to cancel the operation, but success is not guaranteed.
37   * If the server doesn't support this method, it returns
38   * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or
39   * other methods to check whether the cancellation succeeded or whether the
40   * operation completed despite cancellation. On successful cancellation, the
41   * operation is not deleted; instead, it becomes an operation with an
42   * Operation.error value with a google.rpc.Status.code of 1, corresponding to
43   * `Code.CANCELLED`. (operations.cancel)
44   *
45   * @param string $name The name of the operation resource to be cancelled.
46   * @param array $optParams Optional parameters.
47   * @return SpannerEmpty
48   */
49  public function cancel($name, $optParams = [])
50  {
51    $params = ['name' => $name];
52    $params = array_merge($params, $optParams);
53    return $this->call('cancel', [$params], SpannerEmpty::class);
54  }
55  /**
56   * Deletes a long-running operation. This method indicates that the client is no
57   * longer interested in the operation result. It does not cancel the operation.
58   * If the server doesn't support this method, it returns
59   * `google.rpc.Code.UNIMPLEMENTED`. (operations.delete)
60   *
61   * @param string $name The name of the operation resource to be deleted.
62   * @param array $optParams Optional parameters.
63   * @return SpannerEmpty
64   */
65  public function delete($name, $optParams = [])
66  {
67    $params = ['name' => $name];
68    $params = array_merge($params, $optParams);
69    return $this->call('delete', [$params], SpannerEmpty::class);
70  }
71  /**
72   * Gets the latest state of a long-running operation. Clients can use this
73   * method to poll the operation result at intervals as recommended by the API
74   * service. (operations.get)
75   *
76   * @param string $name The name of the operation resource.
77   * @param array $optParams Optional parameters.
78   * @return Operation
79   */
80  public function get($name, $optParams = [])
81  {
82    $params = ['name' => $name];
83    $params = array_merge($params, $optParams);
84    return $this->call('get', [$params], Operation::class);
85  }
86  /**
87   * Lists operations that match the specified filter in the request. If the
88   * server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
89   * `name` binding allows API services to override the binding to use different
90   * resource name schemes, such as `users/operations`. To override the binding,
91   * API services can add a binding such as `"/v1/{name=users}/operations"` to
92   * their service configuration. For backwards compatibility, the default name
93   * includes the operations collection id, however overriding users must ensure
94   * the name binding is the parent resource, without the operations collection
95   * id. (operations.listProjectsInstancesOperations)
96   *
97   * @param string $name The name of the operation's parent resource.
98   * @param array $optParams Optional parameters.
99   *
100   * @opt_param string filter The standard list filter.
101   * @opt_param int pageSize The standard list page size.
102   * @opt_param string pageToken The standard list page token.
103   * @return ListOperationsResponse
104   */
105  public function listProjectsInstancesOperations($name, $optParams = [])
106  {
107    $params = ['name' => $name];
108    $params = array_merge($params, $optParams);
109    return $this->call('list', [$params], ListOperationsResponse::class);
110  }
111}
112
113// Adding a class alias for backwards compatibility with the previous class name.
114class_alias(ProjectsInstancesOperations::class, 'Google_Service_Spanner_Resource_ProjectsInstancesOperations');
115