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