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
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ address |
string
Output only. [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". |
↳ available_features |
array
[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC - IF_CROSS_SITE_NETWORK Check the AvailableFeatures enum for the list of possible values. |
↳ available_link_types |
array
[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR - LINK_TYPE_ETHERNET_400G_LR4 Check the AvailableLinkTypes enum for the list of possible values. |
↳ 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. [Output Only] Creation timestamp inRFC3339 text format. |
↳ cross_site_interconnect_infos |
array<InterconnectLocationCrossSiteInterconnectInfo>
[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed. |
↳ description |
string
Output only. [Output Only] An optional description of the resource. |
↳ facility_provider |
string
Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX). |
↳ facility_provider_facility_id |
string
Output only. [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). |
↳ id |
int|string
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
↳ kind |
string
Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations. |
↳ name |
string
Output only. [Output Only] Name of the resource. |
↳ peeringdb_facility_id |
string
Output only. [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). |
↳ region_infos |
array<InterconnectLocationRegionInfo>
Output only. [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. [Output Only] Server-defined URL for the resource. |
↳ single_region_production_critical_peer_locations |
array
Output only. [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other. |
↳ 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. [Output Only] Reserved for future use. |
getAddress
Output only. [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAddress
clearAddress
setAddress
Output only. [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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".
| Returns | |
|---|---|
| Type | Description |
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailableFeatures
[Output only] List of features available at this InterconnectLocation, which can take one of the following values:
- IF_MACSEC
- IF_CROSS_SITE_NETWORK Check the AvailableFeatures enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAvailableFeatures
[Output only] List of features available at this InterconnectLocation, which can take one of the following values:
- IF_MACSEC
- IF_CROSS_SITE_NETWORK Check the AvailableFeatures enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailableLinkTypes
[Output only] List of link types available at this InterconnectLocation, which can take one of the following values:
- LINK_TYPE_ETHERNET_10G_LR
- LINK_TYPE_ETHERNET_100G_LR
- LINK_TYPE_ETHERNET_400G_LR4 Check the AvailableLinkTypes enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAvailableLinkTypes
[Output only] List of link types available at this InterconnectLocation, which can take one of the following values:
- LINK_TYPE_ETHERNET_10G_LR
- LINK_TYPE_ETHERNET_100G_LR
- LINK_TYPE_ETHERNET_400G_LR4 Check the AvailableLinkTypes enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCity
[Output Only] Metropolitan area designator that indicates which city an interconnect is located.
For example: "Chicago, IL", "Amsterdam, Netherlands".
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCity
clearCity
setCity
[Output Only] Metropolitan area designator that indicates which city an interconnect is located.
For example: "Chicago, IL", "Amsterdam, Netherlands".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCrossSiteInterconnectInfos
[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCrossSiteInterconnectInfos
[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo objects, that describe where Cross-Site Interconnect wires may connect to from this location and associated connection parameters. Cross-Site Interconnect isn't allowed to locations which are not listed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterconnectLocationCrossSiteInterconnectInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Output only. [Output Only] An optional description of the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
Output only. [Output Only] An optional description of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFacilityProvider
Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFacilityProvider
clearFacilityProvider
setFacilityProvider
Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFacilityProviderFacilityId
Output only. [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasFacilityProviderFacilityId
clearFacilityProviderFacilityId
setFacilityProviderFacilityId
Output only. [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasId
clearId
setId
Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Output only. [Output Only] Name of the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasName
clearName
setName
Output only. [Output Only] Name of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPeeringdbFacilityId
Output only. [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPeeringdbFacilityId
clearPeeringdbFacilityId
setPeeringdbFacilityId
Output only. [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegionInfos
Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRegionInfos
Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterconnectLocationRegionInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. [Output Only] Server-defined URL for the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
Output only. [Output Only] Server-defined URL for the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSingleRegionProductionCriticalPeerLocations
Output only. [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setSingleRegionProductionCriticalPeerLocations
Output only. [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSupportsPzs
Output only. [Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSupportsPzs
clearSupportsPzs
setSupportsPzs
Output only. [Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|