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