Compute V1 Client - Class InterconnectRemoteLocation (1.17.0)

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

Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).

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

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.
`↳ attachment_configuration_constraints`	`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints` [Output Only] Subset of fields from InterconnectAttachment's \|configurationConstraints\| field that apply to all attachments for this remote location.
`↳ city`	`string` [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
`↳ constraints`	`Google\Cloud\Compute\V1\InterconnectRemoteLocationConstraints` [Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.
`↳ 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#interconnectRemoteLocation for interconnect remote locations.
`↳ lacp`	`string` [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED Check the Lacp enum for the list of possible values.
`↳ max_lag_size100_gbps`	`int` [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.
`↳ max_lag_size10_gbps`	`int` [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.
`↳ 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).
`↳ permitted_connections`	`array<Google\Cloud\Compute\V1\InterconnectRemoteLocationPermittedConnections>` [Output Only] Permitted connections.
`↳ remote_service`	`string` [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure".
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ status`	`string` [Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. Check the Status enum for the list of possible values.

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`

getAttachmentConfigurationConstraints

[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location.

Returns
Type	Description
`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints\|null`

hasAttachmentConfigurationConstraints

clearAttachmentConfigurationConstraints

setAttachmentConfigurationConstraints

[Output Only] Subset of fields from InterconnectAttachment's |configurationConstraints| field that apply to all attachments for this remote location.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InterconnectAttachmentConfigurationConstraints`

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`

getConstraints

[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.

Returns
Type	Description
`Google\Cloud\Compute\V1\InterconnectRemoteLocationConstraints\|null`

hasConstraints

clearConstraints

setConstraints

[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InterconnectRemoteLocationConstraints`

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

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#interconnectRemoteLocation for interconnect remote locations.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLacp

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED Check the Lacp enum for the list of possible values.

Returns
Type	Description
`string`

hasLacp

clearLacp

setLacp

[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED Check the Lacp enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMaxLagSize100Gbps

[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.

Returns
Type	Description
`int`

hasMaxLagSize100Gbps

clearMaxLagSize100Gbps

setMaxLagSize100Gbps

[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMaxLagSize10Gbps

[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.

Returns
Type	Description
`int`

hasMaxLagSize10Gbps

clearMaxLagSize10Gbps

setMaxLagSize10Gbps

[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.

Parameter
Name	Description
`var`	`int`

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`

getPermittedConnections

[Output Only] Permitted connections.

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

setPermittedConnections

[Output Only] Permitted connections.

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\InterconnectRemoteLocationPermittedConnections>`

Returns
Type	Description
`$this`

getRemoteService

[Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure".

Returns
Type	Description
`string`

hasRemoteService

clearRemoteService

setRemoteService

[Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSelfLink

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

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

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

Check the Status enum for the list of possible values.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`