class RegionCommitments extends Resource (View source)

The "regionCommitments" collection of methods.

Typical usage is:

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

Methods

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

Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (regionCommitments.aggregatedList)

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

Returns the specified commitment resource. (regionCommitments.get)

insert(string $project, string $region, Commitment $postBody, array $optParams = [])

Creates a commitment in the specified project using the data included in the request. (regionCommitments.insert)

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

Retrieves a list of commitments contained within the specified region.

update(string $project, string $region, string $commitment, Commitment $postBody, array $optParams = [])

Updates the specified commitment with the data included in the request.

Details

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

Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (regionCommitments.aggregatedList)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

CommitmentAggregatedList

Exceptions

Exception

Commitment get(string $project, string $region, string $commitment, array $optParams = [])

Returns the specified commitment resource. (regionCommitments.get)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $commitment

Name of the commitment to return.

array $optParams

Optional parameters.

Return Value

Commitment

Exceptions

Exception

Operation insert(string $project, string $region, Commitment $postBody, array $optParams = [])

Creates a commitment in the specified project using the data included in the request. (regionCommitments.insert)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

Commitment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

CommitmentList listRegionCommitments(string $project, string $region, array $optParams = [])

Retrieves a list of commitments contained within the specified region.

(regionCommitments.listRegionCommitments)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

array $optParams

Optional parameters.

Return Value

CommitmentList

Exceptions

Exception

Operation update(string $project, string $region, string $commitment, Commitment $postBody, array $optParams = [])

Updates the specified commitment with the data included in the request.

Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. (regionCommitments.update)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $commitment

Name of the commitment for which auto renew is being updated.

Commitment $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception