117 lines
4.8 KiB
PHP
117 lines
4.8 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
namespace Google\Service\Baremetalsolution\Resource;
|
|
|
|
use Google\Service\Baremetalsolution\BaremetalsolutionEmpty;
|
|
use Google\Service\Baremetalsolution\CancelOperationRequest;
|
|
use Google\Service\Baremetalsolution\ListOperationsResponse;
|
|
use Google\Service\Baremetalsolution\Operation;
|
|
|
|
/**
|
|
* The "operations" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $baremetalsolutionService = new Google\Service\Baremetalsolution(...);
|
|
* $operations = $baremetalsolutionService->operations;
|
|
* </code>
|
|
*/
|
|
class Operations extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Starts asynchronous cancellation on a long-running operation. The server
|
|
* makes a best effort to cancel the operation, but success is not guaranteed.
|
|
* If the server doesn't support this method, it returns
|
|
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or
|
|
* other methods to check whether the cancellation succeeded or whether the
|
|
* operation completed despite cancellation. On successful cancellation, the
|
|
* operation is not deleted; instead, it becomes an operation with an
|
|
* Operation.error value with a google.rpc.Status.code of 1, corresponding to
|
|
* `Code.CANCELLED`. (operations.cancel)
|
|
*
|
|
* @param string $name The name of the operation resource to be cancelled.
|
|
* @param CancelOperationRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return BaremetalsolutionEmpty
|
|
*/
|
|
public function cancel($name, CancelOperationRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('cancel', [$params], BaremetalsolutionEmpty::class);
|
|
}
|
|
/**
|
|
* Deletes a long-running operation. This method indicates that the client is no
|
|
* longer interested in the operation result. It does not cancel the operation.
|
|
* If the server doesn't support this method, it returns
|
|
* `google.rpc.Code.UNIMPLEMENTED`. (operations.delete)
|
|
*
|
|
* @param string $name The name of the operation resource to be deleted.
|
|
* @param array $optParams Optional parameters.
|
|
* @return BaremetalsolutionEmpty
|
|
*/
|
|
public function delete($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('delete', [$params], BaremetalsolutionEmpty::class);
|
|
}
|
|
/**
|
|
* Gets the latest state of a long-running operation. Clients can use this
|
|
* method to poll the operation result at intervals as recommended by the API
|
|
* service. (operations.get)
|
|
*
|
|
* @param string $name The name of the operation resource.
|
|
* @param array $optParams Optional parameters.
|
|
* @return Operation
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Lists operations that match the specified filter in the request. If the
|
|
* server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
|
|
* `name` binding allows API services to override the binding to use different
|
|
* resource name schemes, such as `users/operations`. To override the binding,
|
|
* API services can add a binding such as `"/v1/{name=users}/operations"` to
|
|
* their service configuration. For backwards compatibility, the default name
|
|
* includes the operations collection id, however overriding users must ensure
|
|
* the name binding is the parent resource, without the operations collection
|
|
* id. (operations.listOperations)
|
|
*
|
|
* @param string $name The name of the operation's parent resource.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string filter The standard list filter.
|
|
* @opt_param int pageSize The standard list page size.
|
|
* @opt_param string pageToken The standard list page token.
|
|
* @return ListOperationsResponse
|
|
*/
|
|
public function listOperations($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListOperationsResponse::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(Operations::class, 'Google_Service_Baremetalsolution_Resource_Operations');
|