class ProjectsLocationsOperations extends Resource (View source)

The "operations" collection of methods.

Typical usage is:

 $runService = new Google\Service\CloudRun(...);
 $operations = $runService->projects_locations_operations;

Methods

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.

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)

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.

wait(string $name, GoogleLongrunningWaitOperationRequest $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)

Details

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

Parameters

string $name

The name of the operation resource to be deleted.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleLongrunningOperation 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

GoogleLongrunningOperation

Exceptions

Exception

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

Parameters

string $name

Required. To query for all of the operations for a project.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningListOperationsResponse

Exceptions

Exception

GoogleLongrunningOperation wait(string $name, GoogleLongrunningWaitOperationRequest $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)

Parameters

string $name

The name of the operation resource to wait on.

GoogleLongrunningWaitOperationRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception