1. class
  2. Google
  3. \
  4. Cloud
  5. \
  6. Location
  7. \
  8. Location

Location

class Location extends Message

A resource that represents Google Cloud Platform location.

Generated from protobuf message google.cloud.location.Location

Properties

protected $name Resource name for the location, which may vary between implementations.
protected $location_id The canonical id for this location. For example: "us-east1".
protected $display_name The friendly name for this location, typically a nearby city name.
protected $metadata Service-specific metadata. For example the available capacity at the given location.

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

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

$this
setName(string $var)

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

string
getLocationId()

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

$this
setLocationId(string $var)

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

string
getDisplayName()

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

$this
setDisplayName(string $var)

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

MapField
getLabels()

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

$this
setLabels(array|MapField $var)

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

Any|null
getMetadata()

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

hasMetadata()

No description

clearMetadata()

No description

$this
setMetadata(Any $var)

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

Details

at line 75
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

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

}

at line 87
string getName()

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

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

Generated from protobuf field string name = 1;

Return Value

string

at line 100
$this setName(string $var)

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

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

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 114
string getLocationId()

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

Generated from protobuf field string location_id = 4;

Return Value

string

at line 126
$this setLocationId(string $var)

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

Generated from protobuf field string location_id = 4;

Parameters

string $var

Return Value

$this

at line 141
string getDisplayName()

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

For example, "Tokyo".

Generated from protobuf field string display_name = 5;

Return Value

string

at line 154
$this setDisplayName(string $var)

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

For example, "Tokyo".

Generated from protobuf field string display_name = 5;

Parameters

string $var

Return Value

$this

at line 169
MapField getLabels()

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

Generated from protobuf field map<string, string> labels = 2;

Return Value

MapField

at line 182
$this setLabels(array|MapField $var)

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

Generated from protobuf field map<string, string> labels = 2;

Parameters

array|MapField $var

Return Value

$this

at line 197
Any|null getMetadata()

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

Generated from protobuf field .google.protobuf.Any metadata = 3;

Return Value

Any|null

at line 202
hasMetadata()

at line 207
clearMetadata()

at line 220
$this setMetadata(Any $var)

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

Generated from protobuf field .google.protobuf.Any metadata = 3;

Parameters

Any $var

Return Value

$this