[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\CloudRun\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\CloudRun\GoogleLongrunningCancelOperationRequest;
|
---|
| 21 | use Google\Service\CloudRun\RunEmpty;
|
---|
| 22 |
|
---|
| 23 | /**
|
---|
| 24 | * The "operations" collection of methods.
|
---|
| 25 | * Typical usage is:
|
---|
| 26 | * <code>
|
---|
| 27 | * $runService = new Google\Service\CloudRun(...);
|
---|
| 28 | * $operations = $runService->operations;
|
---|
| 29 | * </code>
|
---|
| 30 | */
|
---|
| 31 | class Operations extends \Google\Service\Resource
|
---|
| 32 | {
|
---|
| 33 | /**
|
---|
| 34 | * Starts asynchronous cancellation on a long-running operation. The server
|
---|
| 35 | * makes a best effort to cancel the operation, but success is not guaranteed.
|
---|
| 36 | * If the server doesn't support this method, it returns
|
---|
| 37 | * `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or
|
---|
| 38 | * other methods to check whether the cancellation succeeded or whether the
|
---|
| 39 | * operation completed despite cancellation. On successful cancellation, the
|
---|
| 40 | * operation is not deleted; instead, it becomes an operation with an
|
---|
| 41 | * Operation.error value with a google.rpc.Status.code of 1, corresponding to
|
---|
| 42 | * `Code.CANCELLED`. (operations.cancel)
|
---|
| 43 | *
|
---|
| 44 | * @param string $name The name of the operation resource to be cancelled.
|
---|
| 45 | * @param GoogleLongrunningCancelOperationRequest $postBody
|
---|
| 46 | * @param array $optParams Optional parameters.
|
---|
| 47 | * @return RunEmpty
|
---|
| 48 | */
|
---|
| 49 | public function cancel($name, GoogleLongrunningCancelOperationRequest $postBody, $optParams = [])
|
---|
| 50 | {
|
---|
| 51 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
| 52 | $params = array_merge($params, $optParams);
|
---|
| 53 | return $this->call('cancel', [$params], RunEmpty::class);
|
---|
| 54 | }
|
---|
| 55 | }
|
---|
| 56 |
|
---|
| 57 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 58 | class_alias(Operations::class, 'Google_Service_CloudRun_Resource_Operations');
|
---|