Google API Common Protos Client - Class Location (4.8.3)

Reference documentation and code samples for the Google API Common Protos Client class Location.

A resource that represents Google Cloud Platform location.

Generated from protobuf message google.cloud.location.Location

Namespace

Google \ Cloud \ Location

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
`↳ location_id`	`string` The canonical id for this location. For example: `"us-east1"`.
`↳ display_name`	`string` The friendly name for this location, typically a nearby city name. For example, "Tokyo".
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
`↳ metadata`	`Google\Protobuf\Any` Service-specific metadata. For example the available capacity at the given location.

getName

Resource name for the location, which may vary between implementations.

For example: "projects/example-project/locations/us-east1"

Returns
Type	Description
`string`

setName

Resource name for the location, which may vary between implementations.

For example: "projects/example-project/locations/us-east1"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocationId

The canonical id for this location. For example: "us-east1".

Returns
Type	Description
`string`

setLocationId

The canonical id for this location. For example: "us-east1".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

The friendly name for this location, typically a nearby city name.

For example, "Tokyo".

Returns
Type	Description
`string`

setDisplayName

The friendly name for this location, typically a nearby city name.

For example, "Tokyo".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getMetadata

Service-specific metadata. For example the available capacity at the given location.

Returns
Type	Description
`Google\Protobuf\Any\|null`

hasMetadata

clearMetadata

setMetadata

Service-specific metadata. For example the available capacity at the given location.

Parameter
Name	Description
`var`	`Google\Protobuf\Any`

Returns
Type	Description
`$this`