target.apidocs.com.google.api.services.compute.Compute.Regions.html Maven / Gradle / Ivy
The newest version!
Compute.Regions (Compute Engine API v1-rev20250320-2.0.0)
com.google.api.services.compute
Class Compute.Regions
- java.lang.Object
-
- com.google.api.services.compute.Compute.Regions
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class
Compute.Regions.Get
class
Compute.Regions.List
-
Constructor Summary
Constructors
Constructor and Description
Regions()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Compute.Regions.Get
get(String project,
String region)
Returns the specified Region resource.
Compute.Regions.List
list(String project)
Retrieves the list of region resources available to the specified project.
-
-
Method Detail
-
get
public Compute.Regions.Get get(String project,
String region)
throws IOException
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.
Create a request for the method "regions.get".
This request holds the parameters needed by the compute server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
project - Project ID for this request.
region - Name of the region resource to return.
- Returns:
- the request
- Throws:
IOException
-
list
public Compute.Regions.List list(String project)
throws IOException
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.
Create a request for the method "regions.list".
This request holds the parameters needed by the compute server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
project - Project ID for this request.
- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2025 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy