ProjectsLocationsOperations
class ProjectsLocationsOperations extends Resource (View source)
The "operations" collection of methods.
Typical usage is:
$translateService = new Google\Service\Translate(...);
$operations = $translateService->projects_locations_operations;Methods
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
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.
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)
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
Waits until the specified long-running operation is done or reaches at most a
specified timeout, returning the latest state. If the operation is already
done, the latest state is immediately returned. If the timeout specified is
greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including
immediately), meaning even an immediate response is no guarantee that the
operation is done. (operations.wait)
Details
TranslateEmpty
cancel(string $name, CancelOperationRequest $postBody, array $optParams = [])
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)
TranslateEmpty
delete(string $name, array $optParams = [])
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)
Operation
get(string $name, array $optParams = [])
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)
ListOperationsResponse
listProjectsLocationsOperations(string $name, array $optParams = [])
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
(operations.listProjectsLocationsOperations)
Operation
wait(string $name, WaitOperationRequest $postBody, array $optParams = [])
Waits until the specified long-running operation is done or reaches at most a
specified timeout, returning the latest state. If the operation is already
done, the latest state is immediately returned. If the timeout specified is
greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If
the server does not support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including
immediately), meaning even an immediate response is no guarantee that the
operation is done. (operations.wait)