REST Resource: projects.locations.cloudLocations

Resource: CloudLocation

Represents resource cloud locations.

JSON representation 
{
  "name": string,
  "containingCloudLocation": string,
  "displayName": string,
  "cloudProvider": enum (CloudProvider),
  "territoryCode": string,
  "cloudLocationType": enum (CloudLocationType),
  "carbonFreeEnergyPercentage": number
}
Fields
name

string

Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: projects/{projectId}/locations/{location}/cloudLocations/{cloudLocation}
containingCloudLocation

string

Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
displayName

string

Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
cloudProvider

enum (CloudProvider)

Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
territoryCode

string

Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
cloudLocationType

enum (CloudLocationType)

Optional. The type of the cloud location.
carbonFreeEnergyPercentage

number

Optional. The carbon free energy percentage of the cloud location. This represents the average percentage of time customers' application will be running on carbon-free energy. See https://cloud.google.com/sustainability/region-carbon for more details. There is a difference between default value 0 and unset value. 0 means the carbon free energy percentage is 0%, while unset value means the carbon footprint data is not available.

CloudProvider

The type of the cloud provider. This enum lists all possible providers of cloud locations.

Enums
CLOUD_PROVIDER_UNSPECIFIED Unspecified type.
CLOUD_PROVIDER_GCP Cloud provider type for Google Cloud.
CLOUD_PROVIDER_AWS Cloud provider type for AWS.
CLOUD_PROVIDER_AZURE Cloud provider type for Azure.
CLOUD_PROVIDER_OCI Cloud provider type for OCI.

CloudLocationType

The type of the cloud location. This enum lists all possible categories of cloud locations.

Enums
CLOUD_LOCATION_TYPE_UNSPECIFIED Unspecified type.
CLOUD_LOCATION_TYPE_REGION CloudLocation type for region.
CLOUD_LOCATION_TYPE_ZONE CloudLocation type for zone.
CLOUD_LOCATION_TYPE_REGION_EXTENSION CloudLocation type for region extension.

Methods

get

 Retrieves a resource containing information about a cloud location.

list

 Lists cloud locations under a given project and location.
Searches for cloud locations from a given source location.