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\Document\Resource;
19
20use Google\Service\Document\GoogleLongrunningListOperationsResponse;
21use Google\Service\Document\GoogleLongrunningOperation;
22use Google\Service\Document\GoogleProtobufEmpty;
23
24/**
25 * The "operations" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $documentaiService = new Google\Service\Document(...);
29 *   $operations = $documentaiService->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 array $optParams Optional parameters.
47   * @return GoogleProtobufEmpty
48   */
49  public function cancel($name, $optParams = [])
50  {
51    $params = ['name' => $name];
52    $params = array_merge($params, $optParams);
53    return $this->call('cancel', [$params], GoogleProtobufEmpty::class);
54  }
55  /**
56   * Gets the latest state of a long-running operation. Clients can use this
57   * method to poll the operation result at intervals as recommended by the API
58   * service. (operations.get)
59   *
60   * @param string $name The name of the operation resource.
61   * @param array $optParams Optional parameters.
62   * @return GoogleLongrunningOperation
63   */
64  public function get($name, $optParams = [])
65  {
66    $params = ['name' => $name];
67    $params = array_merge($params, $optParams);
68    return $this->call('get', [$params], GoogleLongrunningOperation::class);
69  }
70  /**
71   * Lists operations that match the specified filter in the request. If the
72   * server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
73   * `name` binding allows API services to override the binding to use different
74   * resource name schemes, such as `users/operations`. To override the binding,
75   * API services can add a binding such as `"/v1/{name=users}/operations"` to
76   * their service configuration. For backwards compatibility, the default name
77   * includes the operations collection id, however overriding users must ensure
78   * the name binding is the parent resource, without the operations collection
79   * id. (operations.listProjectsLocationsOperations)
80   *
81   * @param string $name The name of the operation's parent resource.
82   * @param array $optParams Optional parameters.
83   *
84   * @opt_param string filter The standard list filter.
85   * @opt_param int pageSize The standard list page size.
86   * @opt_param string pageToken The standard list page token.
87   * @return GoogleLongrunningListOperationsResponse
88   */
89  public function listProjectsLocationsOperations($name, $optParams = [])
90  {
91    $params = ['name' => $name];
92    $params = array_merge($params, $optParams);
93    return $this->call('list', [$params], GoogleLongrunningListOperationsResponse::class);
94  }
95}
96
97// Adding a class alias for backwards compatibility with the previous class name.
98class_alias(ProjectsLocationsOperations::class, 'Google_Service_Document_Resource_ProjectsLocationsOperations');
99