Compute V1 Client - Class InterconnectGroupsCreateMembersInterconnectInput (1.31.0)

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

LINT.IfChange

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ admin_enabled bool

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

↳ customer_name string

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

↳ description string

An optional description of this resource. Provide this property when you create the resource.

↳ facility string

A zone-free location to use for all Interconnects created in this call, like "iad-1234".

↳ interconnect_type string

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. Check the InterconnectType enum for the list of possible values.

↳ link_type string

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. Check the LinkType enum for the list of possible values.

↳ name string

Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

↳ noc_contact_email string

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

↳ remote_location string

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

↳ requested_features array

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. Check the RequestedFeatures enum for the list of possible values.

↳ requested_link_count int

Target number of physical links in the link bundle, as requested by the customer.

getAdminEnabled

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

Returns
Type Description
bool

hasAdminEnabled

clearAdminEnabled

setAdminEnabled

Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCustomerName

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

Returns
Type Description
string

hasCustomerName

clearCustomerName

setCustomerName

Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getFacility

A zone-free location to use for all Interconnects created in this call, like "iad-1234".

Returns
Type Description
string

hasFacility

clearFacility

setFacility

A zone-free location to use for all Interconnects created in this call, like "iad-1234".

Parameter
Name Description
var string
Returns
Type Description
$this

getInterconnectType

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

Check the InterconnectType enum for the list of possible values.

Returns
Type Description
string

hasInterconnectType

clearInterconnectType

setInterconnectType

Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.

Check the InterconnectType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getLinkType

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

Check the LinkType enum for the list of possible values.

Returns
Type Description
string

hasLinkType

clearLinkType

setLinkType

Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.

Check the LinkType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the Interconnects to be created. This must be specified on the template and/or on each individual interconnect. The name, if not empty, must be 1-63 characters long, and comply with RFC1035. Specifically, any nonempty name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getNocContactEmail

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

Returns
Type Description
string

hasNocContactEmail

clearNocContactEmail

setNocContactEmail

Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.

Parameter
Name Description
var string
Returns
Type Description
$this

getRemoteLocation

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

Returns
Type Description
string

hasRemoteLocation

clearRemoteLocation

setRemoteLocation

Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestedFeatures

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.

Check the RequestedFeatures enum for the list of possible values.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRequestedFeatures

Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.

Check the RequestedFeatures enum for the list of possible values.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getRequestedLinkCount

Target number of physical links in the link bundle, as requested by the customer.

Returns
Type Description
int

hasRequestedLinkCount

clearRequestedLinkCount

setRequestedLinkCount

Target number of physical links in the link bundle, as requested by the customer.

Parameter
Name Description
var int
Returns
Type Description
$this