1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. RegionOperations

RegionOperations

class RegionOperations extends Resource (View source)

The "regionOperations" collection of methods.

Typical usage is:

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

Methods

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

Deletes the specified region-specific Operations resource.

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

Retrieves the specified region-specific Operations resource.

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

Retrieves a list of Operation resources contained within the specified region. (regionOperations.listRegionOperations)

Operation
wait(string $project, string $region, 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

at line 44
delete(string $project, string $region, string $operation, array $optParams = [])

Deletes the specified region-specific Operations resource.

(regionOperations.delete)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $operation

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

Optional parameters.

Exceptions

Exception

at line 62
Operation get(string $project, string $region, string $operation, array $optParams = [])

Retrieves the specified region-specific Operations resource.

(regionOperations.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region 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

at line 132
OperationList listRegionOperations(string $project, string $region, array $optParams = [])

Retrieves a list of Operation resources contained within the specified region. (regionOperations.listRegionOperations)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
array $optParams

Optional parameters.

Return Value

OperationList

Exceptions

Exception

at line 159
Operation wait(string $project, string $region, 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. (regionOperations.wait)

Parameters

string $project

Project ID for this request.
string $region

Name of the region 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