Google Cloud Location Finder V1 Client - Class CloudLocation (0.1.0)

Reference documentation and code samples for the Google Cloud Location Finder V1 Client class CloudLocation.

Represents resource cloud locations.

Generated from protobuf message google.cloud.locationfinder.v1.CloudLocation

Namespace

Google \ Cloud \ LocationFinder \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ 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}`
`↳ containing_cloud_location`	`string` Output only. The containing cloud location in the strict nesting hierarchy. For example, the containing cloud location of a zone is a region.
`↳ display_name`	`string` Optional. The human-readable name of the cloud location. Example: us-east-2, us-east1.
`↳ cloud_provider`	`int` Optional. The provider of the cloud location. Values can be Google Cloud or third-party providers, including AWS, Azure, or Oracle Cloud Infrastructure.
`↳ territory_code`	`string` Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location. Examples: US, JP, KR.
`↳ cloud_location_type`	`int` Optional. The type of the cloud location.
`↳ carbon_free_energy_percentage`	`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.

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}

Returns
Type	Description
`string`

setName

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}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getContainingCloudLocation

Output only. The containing cloud location in the strict nesting hierarchy.

For example, the containing cloud location of a zone is a region.

Returns
Type	Description
`string`

setContainingCloudLocation

Output only. The containing cloud location in the strict nesting hierarchy.

For example, the containing cloud location of a zone is a region.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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

Returns
Type	Description
`string`

setDisplayName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCloudProvider

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

Returns
Type	Description
`int`	Enum of type CloudProvider.

setCloudProvider

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

Parameter
Name	Description
`var`	`int` Enum of type CloudProvider.

Returns
Type	Description
`$this`

getTerritoryCode

Optional. The two-letter ISO 3166-1 alpha-2 code of the cloud location.

Examples: US, JP, KR.

Returns
Type	Description
`string`

setTerritoryCode