Cloud Location Finder v1 API - Class CloudLocation (1.0.0-beta01)

public sealed class CloudLocation : IMessage<CloudLocation>, IEquatable<CloudLocation>, IDeepCloneable<CloudLocation>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Location Finder v1 API class CloudLocation.

Represents resource cloud locations.

Inheritance

object > CloudLocation

Namespace

Google.Cloud.LocationFinder.V1

Assembly

Google.Cloud.LocationFinder.V1.dll

Constructors

CloudLocation()

public CloudLocation()

CloudLocation(CloudLocation)

public CloudLocation(CloudLocation other)
Parameter
Name Description
other CloudLocation

Properties

CarbonFreeEnergyPercentage

public float CarbonFreeEnergyPercentage { get; set; }

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.

Property Value
Type Description
float

CloudLocationName

public CloudLocationName CloudLocationName { get; set; }

CloudLocationName-typed view over the Name resource name property.

Property Value
Type Description
CloudLocationName

CloudLocationType

public CloudLocation.Types.CloudLocationType CloudLocationType { get; set; }

Optional. The type of the cloud location.

Property Value
Type Description
CloudLocationTypesCloudLocationType

CloudProvider

public CloudLocation.Types.CloudProvider CloudProvider { get; set; }

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

Property Value
Type Description
CloudLocationTypesCloudProvider

ContainingCloudLocation

public string ContainingCloudLocation { get; set; }

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

Property Value
Type Description
string

ContainingCloudLocationAsCloudLocationName

public CloudLocationName ContainingCloudLocationAsCloudLocationName { get; set; }

CloudLocationName-typed view over the ContainingCloudLocation resource name property.

Property Value
Type Description
CloudLocationName

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

HasCarbonFreeEnergyPercentage

public bool HasCarbonFreeEnergyPercentage { get; }

Gets whether the "carbon_free_energy_percentage" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

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}

Property Value
Type Description
string

TerritoryCode

public string TerritoryCode { get; set; }

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

Property Value
Type Description
string