source: vendor/google/apiclient-services/src/Texttospeech/Resource/Operations.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 2 weeks ago

Upload project files

  • Property mode set to 100644
File size: 3.0 KB
Line 
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\Texttospeech\Resource;
19
20use Google\Service\Texttospeech\CancelOperationRequest;
21use Google\Service\Texttospeech\TexttospeechEmpty;
22
23/**
24 * The "operations" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $texttospeechService = new Google\Service\Texttospeech(...);
28 * $operations = $texttospeechService->operations;
29 * </code>
30 */
31class 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 CancelOperationRequest $postBody
46 * @param array $optParams Optional parameters.
47 * @return TexttospeechEmpty
48 * @throws \Google\Service\Exception
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], TexttospeechEmpty::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 TexttospeechEmpty
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], TexttospeechEmpty::class);
72 }
73}
74
75// Adding a class alias for backwards compatibility with the previous class name.
76class_alias(Operations::class, 'Google_Service_Texttospeech_Resource_Operations');
Note: See TracBrowser for help on using the repository browser.