Regions
class Regions extends Resource (View source)
The "regions" collection of methods.
Typical usage is:
$computeService = new Google\Service\Compute(...);
$regions = $computeService->regions;Methods
Returns the specified Region resource. To decrease latency for this method,
you can optionally omit any unneeded information from the response by using a
field mask. This practice is especially recommended for unused quota
information (the quotas field). To exclude one or more fields, set your
request's fields query parameter to only include the fields you need. For
example, to only include the id and selfLink fields, add the query
parameter ?fields=id,selfLink to your request. This method fails if the
quota information is unavailable for the region and if the organization
policy constraint compute.requireBasicQuotaInResponse is enforced. This
constraint, when enforced, disables the fail-open behaviour when quota
information (the items.quotas field) is unavailable for the region. It is
recommended to use the default setting for the constraint unless your
application requires the fail-closed behaviour for this method. (regions.get)
Retrieves the list of region resources available to the specified project. To
decrease latency for this method, you can optionally omit any unneeded
information from the response by using a field mask. This practice is
especially recommended for unused quota information (the items.quotas
field). To exclude one or more fields, set your request's fields query
parameter to only include the fields you need. For example, to only include
the id and selfLink fields, add the query parameter ?fields=id,selfLink
to your request. This method fails if the quota information is unavailable
for the region and if the organization policy constraint
compute.requireBasicQuotaInResponse is enforced. This constraint, when
enforced, disables the fail-open behaviour when quota information (the
items.quotas field) is unavailable for the region. It is recommended to use
the default setting for the constraint unless your application requires the
fail-closed behaviour for this method. (regions.listRegions)
Details
Region
get(string $project, string $region, array $optParams = [])
Returns the specified Region resource. To decrease latency for this method,
you can optionally omit any unneeded information from the response by using a
field mask. This practice is especially recommended for unused quota
information (the quotas field). To exclude one or more fields, set your
request's fields query parameter to only include the fields you need. For
example, to only include the id and selfLink fields, add the query
parameter ?fields=id,selfLink to your request. This method fails if the
quota information is unavailable for the region and if the organization
policy constraint compute.requireBasicQuotaInResponse is enforced. This
constraint, when enforced, disables the fail-open behaviour when quota
information (the items.quotas field) is unavailable for the region. It is
recommended to use the default setting for the constraint unless your
application requires the fail-closed behaviour for this method. (regions.get)
RegionList
listRegions(string $project, array $optParams = [])
Retrieves the list of region resources available to the specified project. To
decrease latency for this method, you can optionally omit any unneeded
information from the response by using a field mask. This practice is
especially recommended for unused quota information (the items.quotas
field). To exclude one or more fields, set your request's fields query
parameter to only include the fields you need. For example, to only include
the id and selfLink fields, add the query parameter ?fields=id,selfLink
to your request. This method fails if the quota information is unavailable
for the region and if the organization policy constraint
compute.requireBasicQuotaInResponse is enforced. This constraint, when
enforced, disables the fail-open behaviour when quota information (the
items.quotas field) is unavailable for the region. It is recommended to use
the default setting for the constraint unless your application requires the
fail-closed behaviour for this method. (regions.listRegions)