[e3d4e0a] | 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 |
|
---|
| 18 | namespace Google\Service\Spanner\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Spanner\ListOperationsResponse;
|
---|
| 21 | use Google\Service\Spanner\Operation;
|
---|
| 22 | use 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->projects_instances_backups_operations;
|
---|
| 30 | * </code>
|
---|
| 31 | */
|
---|
| 32 | class ProjectsInstancesBackupsOperations 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 | * @throws \Google\Service\Exception
|
---|
| 49 | */
|
---|
| 50 | public function cancel($name, $optParams = [])
|
---|
| 51 | {
|
---|
| 52 | $params = ['name' => $name];
|
---|
| 53 | $params = array_merge($params, $optParams);
|
---|
| 54 | return $this->call('cancel', [$params], SpannerEmpty::class);
|
---|
| 55 | }
|
---|
| 56 | /**
|
---|
| 57 | * Deletes a long-running operation. This method indicates that the client is no
|
---|
| 58 | * longer interested in the operation result. It does not cancel the operation.
|
---|
| 59 | * If the server doesn't support this method, it returns
|
---|
| 60 | * `google.rpc.Code.UNIMPLEMENTED`. (operations.delete)
|
---|
| 61 | *
|
---|
| 62 | * @param string $name The name of the operation resource to be deleted.
|
---|
| 63 | * @param array $optParams Optional parameters.
|
---|
| 64 | * @return SpannerEmpty
|
---|
| 65 | * @throws \Google\Service\Exception
|
---|
| 66 | */
|
---|
| 67 | public function delete($name, $optParams = [])
|
---|
| 68 | {
|
---|
| 69 | $params = ['name' => $name];
|
---|
| 70 | $params = array_merge($params, $optParams);
|
---|
| 71 | return $this->call('delete', [$params], SpannerEmpty::class);
|
---|
| 72 | }
|
---|
| 73 | /**
|
---|
| 74 | * Gets the latest state of a long-running operation. Clients can use this
|
---|
| 75 | * method to poll the operation result at intervals as recommended by the API
|
---|
| 76 | * service. (operations.get)
|
---|
| 77 | *
|
---|
| 78 | * @param string $name The name of the operation resource.
|
---|
| 79 | * @param array $optParams Optional parameters.
|
---|
| 80 | * @return Operation
|
---|
| 81 | * @throws \Google\Service\Exception
|
---|
| 82 | */
|
---|
| 83 | public function get($name, $optParams = [])
|
---|
| 84 | {
|
---|
| 85 | $params = ['name' => $name];
|
---|
| 86 | $params = array_merge($params, $optParams);
|
---|
| 87 | return $this->call('get', [$params], Operation::class);
|
---|
| 88 | }
|
---|
| 89 | /**
|
---|
| 90 | * Lists operations that match the specified filter in the request. If the
|
---|
| 91 | * server doesn't support this method, it returns `UNIMPLEMENTED`.
|
---|
| 92 | * (operations.listProjectsInstancesBackupsOperations)
|
---|
| 93 | *
|
---|
| 94 | * @param string $name The name of the operation's parent resource.
|
---|
| 95 | * @param array $optParams Optional parameters.
|
---|
| 96 | *
|
---|
| 97 | * @opt_param string filter The standard list filter.
|
---|
| 98 | * @opt_param int pageSize The standard list page size.
|
---|
| 99 | * @opt_param string pageToken The standard list page token.
|
---|
| 100 | * @return ListOperationsResponse
|
---|
| 101 | * @throws \Google\Service\Exception
|
---|
| 102 | */
|
---|
| 103 | public function listProjectsInstancesBackupsOperations($name, $optParams = [])
|
---|
| 104 | {
|
---|
| 105 | $params = ['name' => $name];
|
---|
| 106 | $params = array_merge($params, $optParams);
|
---|
| 107 | return $this->call('list', [$params], ListOperationsResponse::class);
|
---|
| 108 | }
|
---|
| 109 | }
|
---|
| 110 |
|
---|
| 111 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 112 | class_alias(ProjectsInstancesBackupsOperations::class, 'Google_Service_Spanner_Resource_ProjectsInstancesBackupsOperations');
|
---|