Compute V1 Client - Class InterconnectLocation (1.5.0)

Reference documentation and code samples for the Compute V1 Client class InterconnectLocation.

Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.

Generated from protobuf message google.cloud.compute.v1.InterconnectLocation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ address string

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

↳ availability_zone string

[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".

↳ city string

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

↳ continent string

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA Check the Continent enum for the list of possible values.

↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.

↳ description string

[Output Only] An optional description of the resource.

↳ facility_provider string

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

↳ facility_provider_facility_id string

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

↳ id int|string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

↳ kind string

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.

↳ name string

[Output Only] Name of the resource.

↳ peeringdb_facility_id string

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

↳ region_infos array<Google\Cloud\Compute\V1\InterconnectLocationRegionInfo>

[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.

↳ self_link string

[Output Only] Server-defined URL for the resource.

↳ status string

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. Check the Status enum for the list of possible values.

↳ supports_pzs bool

[Output Only] Set to true for locations that support physical zone separation. Defaults to false if the field is not present.

getAddress

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

Generated from protobuf field optional string address = 462920692;

Returns
TypeDescription
string

hasAddress

clearAddress

setAddress

[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.

Generated from protobuf field optional string address = 462920692;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAvailabilityZone

[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".

Generated from protobuf field optional string availability_zone = 158459920;

Returns
TypeDescription
string

hasAvailabilityZone

clearAvailabilityZone

setAvailabilityZone

[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2".

Generated from protobuf field optional string availability_zone = 158459920;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCity

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

Generated from protobuf field optional string city = 3053931;

Returns
TypeDescription
string

hasCity

clearCity

setCity

[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".

Generated from protobuf field optional string city = 3053931;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getContinent

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA Check the Continent enum for the list of possible values.

Generated from protobuf field optional string continent = 133442996;

Returns
TypeDescription
string

hasContinent

clearContinent

setContinent

[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA Check the Continent enum for the list of possible values.

Generated from protobuf field optional string continent = 133442996;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

[Output Only] An optional description of the resource.

Generated from protobuf field optional string description = 422937596;

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

[Output Only] An optional description of the resource.

Generated from protobuf field optional string description = 422937596;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFacilityProvider

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

Generated from protobuf field optional string facility_provider = 533303309;

Returns
TypeDescription
string

hasFacilityProvider

clearFacilityProvider

setFacilityProvider

[Output Only] The name of the provider for this facility (e.g., EQUINIX).

Generated from protobuf field optional string facility_provider = 533303309;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFacilityProviderFacilityId

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

Generated from protobuf field optional string facility_provider_facility_id = 87269125;

Returns
TypeDescription
string

hasFacilityProviderFacilityId

clearFacilityProviderFacilityId

setFacilityProviderFacilityId

[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

Generated from protobuf field optional string facility_provider_facility_id = 87269125;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Returns
TypeDescription
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getKind

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

[Output Only] Name of the resource.

Generated from protobuf field optional string name = 3373707;

Returns
TypeDescription
string

hasName

clearName

setName

[Output Only] Name of the resource.

Generated from protobuf field optional string name = 3373707;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPeeringdbFacilityId

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

Generated from protobuf field optional string peeringdb_facility_id = 536567094;

Returns
TypeDescription
string

hasPeeringdbFacilityId

clearPeeringdbFacilityId

setPeeringdbFacilityId

[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).

Generated from protobuf field optional string peeringdb_facility_id = 536567094;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRegionInfos

[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.

Generated from protobuf field repeated .google.cloud.compute.v1.InterconnectLocationRegionInfo region_infos = 312194170;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRegionInfos

[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.

Generated from protobuf field repeated .google.cloud.compute.v1.InterconnectLocationRegionInfo region_infos = 312194170;

Parameter
NameDescription
var array<Google\Cloud\Compute\V1\InterconnectLocationRegionInfo>
Returns
TypeDescription
$this

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.

Check the Status enum for the list of possible values.

Generated from protobuf field optional string status = 181260274;

Returns
TypeDescription
string

hasStatus

clearStatus

setStatus

[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.

Check the Status enum for the list of possible values.

Generated from protobuf field optional string status = 181260274;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSupportsPzs

[Output Only] Set to true for locations that support physical zone separation. Defaults to false if the field is not present.

Generated from protobuf field optional bool supports_pzs = 83983214;

Returns
TypeDescription
bool

hasSupportsPzs

clearSupportsPzs

setSupportsPzs

[Output Only] Set to true for locations that support physical zone separation. Defaults to false if the field is not present.

Generated from protobuf field optional bool supports_pzs = 83983214;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this