class ProjectsLocationsOperations extends Resource (View source)

The "operations" collection of methods.

Typical usage is:

 $cloudbuildService = new Google\Service\CloudBuild(...);
 $operations = $cloudbuildService->projects_locations_operations;

Methods

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.

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)

Details

CloudbuildEmpty 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)

Parameters

string $name

The name of the operation resource to be cancelled.

CancelOperationRequest $postBody
array $optParams

Optional parameters.

Return Value

CloudbuildEmpty

Exceptions

Exception

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)

Parameters

string $name

The name of the operation resource.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception