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\CloudBuild\Resource;
19
20use Google\Service\CloudBuild\CancelOperationRequest;
21use Google\Service\CloudBuild\CloudbuildEmpty;
22use Google\Service\CloudBuild\Operation;
23
24/**
25 * The "operations" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $cloudbuildService = new Google\Service\CloudBuild(...);
29 *   $operations = $cloudbuildService->operations;
30 *  </code>
31 */
32class ProjectsLocationsOperations 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 CancelOperationRequest $postBody
47   * @param array $optParams Optional parameters.
48   * @return CloudbuildEmpty
49   */
50  public function cancel($name, CancelOperationRequest $postBody, $optParams = [])
51  {
52    $params = ['name' => $name, 'postBody' => $postBody];
53    $params = array_merge($params, $optParams);
54    return $this->call('cancel', [$params], CloudbuildEmpty::class);
55  }
56  /**
57   * Gets the latest state of a long-running operation. Clients can use this
58   * method to poll the operation result at intervals as recommended by the API
59   * service. (operations.get)
60   *
61   * @param string $name The name of the operation resource.
62   * @param array $optParams Optional parameters.
63   * @return Operation
64   */
65  public function get($name, $optParams = [])
66  {
67    $params = ['name' => $name];
68    $params = array_merge($params, $optParams);
69    return $this->call('get', [$params], Operation::class);
70  }
71}
72
73// Adding a class alias for backwards compatibility with the previous class name.
74class_alias(ProjectsLocationsOperations::class, 'Google_Service_CloudBuild_Resource_ProjectsLocationsOperations');
75