cloud_locations

Creates, updates, deletes, gets or lists a cloud_locations resource.

Overview

Name	cloud_locations
Type	Resource
Id	google.cloudlocationfinder.cloud_locations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}
carbonFreeEnergyPercentage	number (float)	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.
cloudLocationType	string	Optional. The type of the cloud location.
cloudProvider	string	Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
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.
territoryCode	string	Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the cloud location. Unique name of the cloud location including project and location using the form: projects/{project_id}/locations/{location}/cloudLocations/{cloud_location}
carbonFreeEnergyPercentage	number (float)	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.
cloudLocationType	string	Optional. The type of the cloud location.
cloudProvider	string	Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
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.
territoryCode	string	Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, cloudLocationsId		Retrieves a resource containing information about a cloud location.
list	select	projectsId, locationsId	pageSize, pageToken, filter	Lists cloud locations under a given project and location.
search	exec	projectsId, locationsId	sourceCloudLocation, pageSize, pageToken, query	Searches for cloud locations from a given source location.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloudLocationsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
query	string
sourceCloudLocation	string

SELECT examples

get

Retrieves a resource containing information about a cloud location.

SELECT
name,
carbonFreeEnergyPercentage,
cloudLocationType,
cloudProvider,
containingCloudLocation,
displayName,
territoryCode
FROM google.cloudlocationfinder.cloud_locations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND cloudLocationsId = '{{ cloudLocationsId }}' -- required;

list

Lists cloud locations under a given project and location.

SELECT
name,
carbonFreeEnergyPercentage,
cloudLocationType,
cloudProvider,
containingCloudLocation,
displayName,
territoryCode
FROM google.cloudlocationfinder.cloud_locations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

Lifecycle Methods

search

Searches for cloud locations from a given source location.

EXEC google.cloudlocationfinder.cloud_locations.search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@sourceCloudLocation='{{ sourceCloudLocation }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}', 
@query='{{ query }}';