Compute V1 Client - Class InterconnectLocation (1.33.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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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".

↳ available_features array

[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC 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] 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<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] Reserved for future use.

getAddress

[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] 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 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 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] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

[Output Only] An optional description of the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

[Output Only] An optional description of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getFacilityProvider

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

Returns
Type Description
string

hasFacilityProvider

clearFacilityProvider

setFacilityProvider

[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] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).

Returns
Type Description
string

hasFacilityProviderFacilityId

clearFacilityProviderFacilityId

setFacilityProviderFacilityId

[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] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

[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] Type of the resource. Always compute#interconnectLocation for interconnect locations.

Returns
Type Description
string

hasKind

clearKind

setKind

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

Parameter
Name Description
var string
Returns
Type Description
$this

getName

[Output Only] Name of the resource.

Returns
Type Description
string

hasName

clearName

setName

[Output Only] Name of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeeringdbFacilityId

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

Returns
Type Description
string

hasPeeringdbFacilityId

clearPeeringdbFacilityId

setPeeringdbFacilityId

[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] 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] 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

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

Returns
Type Description
string

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

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] Reserved for future use.

Returns
Type Description
bool

hasSupportsPzs

clearSupportsPzs

setSupportsPzs

[Output Only] Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this