class GlobalOperations extends Resource (View source)

The "globalOperations" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $globalOperations = $computeService->globalOperations;

Methods

aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

delete(string $project, string $operation, array $optParams = [])

Deletes the specified Operations resource. (globalOperations.delete)

get(string $project, string $operation, array $optParams = [])

Retrieves the specified Operations resource. (globalOperations.get)

listGlobalOperations(string $project, array $optParams = [])

Retrieves a list of Operation resources contained within the specified project. (globalOperations.listGlobalOperations)

wait(string $project, string $operation, array $optParams = [])

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress.

Details

OperationAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(globalOperations.aggregatedList)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

OperationAggregatedList

Exceptions

Exception

delete(string $project, string $operation, array $optParams = [])

Deletes the specified Operations resource. (globalOperations.delete)

Parameters

string $project

Project ID for this request.

string $operation

Name of the Operations resource to delete, or its unique numeric identifier.

array $optParams

Optional parameters.

Exceptions

Exception

Operation get(string $project, string $operation, array $optParams = [])

Retrieves the specified Operations resource. (globalOperations.get)

Parameters

string $project

Project ID for this request.

string $operation

Name of the Operations resource to return, or its unique numeric identifier.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

OperationList listGlobalOperations(string $project, array $optParams = [])

Retrieves a list of Operation resources contained within the specified project. (globalOperations.listGlobalOperations)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

OperationList

Exceptions

Exception

Operation wait(string $project, string $operation, array $optParams = [])

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress.

This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. (globalOperations.wait)

Parameters

string $project

Project ID for this request.

string $operation

Name of the Operations resource to return, or its unique numeric identifier.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception