public interface CloudLocationOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCarbonFreeEnergyPercentage()
public abstract float getCarbonFreeEnergyPercentage()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.
optional float carbon_free_energy_percentage = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The carbonFreeEnergyPercentage. |
getCloudLocationType()
public abstract CloudLocation.CloudLocationType getCloudLocationType()Optional. The type of the cloud location.
.google.cloud.locationfinder.v1.CloudLocation.CloudLocationType cloud_location_type = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudLocation.CloudLocationType |
The cloudLocationType. |
getCloudLocationTypeValue()
public abstract int getCloudLocationTypeValue()Optional. The type of the cloud location.
.google.cloud.locationfinder.v1.CloudLocation.CloudLocationType cloud_location_type = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for cloudLocationType. |
getCloudProvider()
public abstract CloudLocation.CloudProvider getCloudProvider()Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
.google.cloud.locationfinder.v1.CloudLocation.CloudProvider cloud_provider = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
CloudLocation.CloudProvider |
The cloudProvider. |
getCloudProviderValue()
public abstract int getCloudProviderValue()Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
.google.cloud.locationfinder.v1.CloudLocation.CloudProvider cloud_provider = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for cloudProvider. |
getContainingCloudLocation()
public abstract String getContainingCloudLocation()Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
string containing_cloud_location = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The containingCloudLocation. |
getContainingCloudLocationBytes()
public abstract ByteString getContainingCloudLocationBytes()Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
string containing_cloud_location = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for containingCloudLocation. |
getDisplayName()
public abstract String getDisplayName()Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract ByteString getDisplayNameBytes()Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getName()
public abstract String getName() 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}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() 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}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getTerritoryCode()
public abstract String getTerritoryCode()Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
string territory_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The territoryCode. |
getTerritoryCodeBytes()
public abstract ByteString getTerritoryCodeBytes()Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
string territory_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for territoryCode. |
hasCarbonFreeEnergyPercentage()
public abstract boolean hasCarbonFreeEnergyPercentage()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.
optional float carbon_free_energy_percentage = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the carbonFreeEnergyPercentage field is set. |