java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.network.interconnect.Tenant

```
@ApiType("SoftLayer_Network_Interconnect_Tenant")
public class Tenant
extends Entity
```
A network interconnect tenant defines an IP routing path through a network interconnect. Each network interconnect requires a single primary tenant, indicated by the primaryFlag

See Also:

SoftLayer_Network_Interconnect_Tenant

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Tenant.Mask`
`static interface`	`Tenant.Service`	A network interconnect tenant defines an IP routing path through a network interconnect.
`static interface`	`Tenant.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`accountId`
`protected boolean`	`accountIdSpecified`
`protected Long`	`bgpAsn`	Specifies ASN used for BGP.
`protected boolean`	`bgpAsnSpecified`
`protected Interconnect`	`billingItem`	The active billing item for a network interconnect.
`protected GregorianCalendar`	`createDate`
`protected boolean`	`createDateSpecified`
`protected String`	`datacenterName`
`protected String`	`errorMessage`
`protected boolean`	`errorMessageSpecified`
`protected Boolean`	`globalRoutingFlag`	The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag = 1 and local connectivity if globalRoutingFlag = 0.
`protected boolean`	`globalRoutingFlagSpecified`
`protected Long`	`id`
`protected boolean`	`idSpecified`
`protected String`	`interconnectType`
`protected boolean`	`interconnectTypeSpecified`
`protected Long`	`linkSpeed`	Link speed of a Direct Link connection.
`protected boolean`	`linkSpeedSpecified`
`protected String`	`localIpAddress`	IP address (v4 or v6) of "near" router serial interface.
`protected boolean`	`localIpAddressSpecified`
`protected String`	`location`
`protected boolean`	`locationSpecified`
`protected GregorianCalendar`	`modifyDate`
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	Specifies the Interconnect connection name.
`protected boolean`	`nameSpecified`
`protected Long`	`newLinkSpeed`	Updated Link speed of a Direct Link connection.
`protected boolean`	`newLinkSpeedSpecified`
`protected String`	`note`	This field will have the ticket id if the tenant workflow fails
`protected boolean`	`noteSpecified`
`protected Long`	`peerLinkSpeed`	Link speed of a Direct Link connection on Equinix Side.
`protected boolean`	`peerLinkSpeedSpecified`
`protected String`	`port`
`protected String`	`portLabel`
`protected boolean`	`portSpecified`
`protected String`	`provider`
`protected Long`	`providerAccountId`
`protected boolean`	`providerAccountIdSpecified`
`protected boolean`	`providerSpecified`
`protected Boolean`	`redundancyFlag`	Specifies redundant connection is available if 1.
`protected boolean`	`redundancyFlagSpecified`
`protected String`	`remoteIpAddress`
`protected boolean`	`remoteIpAddressSpecified`
`protected String`	`serviceKey`	Service key for Interconnect connection.
`protected boolean`	`serviceKeySpecified`
`protected ServiceType`	`serviceType`
`protected Long`	`serviceTypeId`
`protected boolean`	`serviceTypeIdSpecified`
`protected String`	`status`	The direct link connection status.
`protected boolean`	`statusSpecified`
`protected String`	`vendorName`
`protected Long`	`vlanId`
`protected boolean`	`vlanIdSpecified`
`protected String`	`zoneName`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Tenant()

Method Summary

Modifier and Type	Method	Description
`Tenant.Service`	`asService(ApiClient client)`
`Long`	`getAccountId()`
`Long`	`getBgpAsn()`
`Interconnect`	`getBillingItem()`
`GregorianCalendar`	`getCreateDate()`
`String`	`getDatacenterName()`
`String`	`getErrorMessage()`
`Boolean`	`getGlobalRoutingFlag()`
`Long`	`getId()`
`String`	`getInterconnectType()`
`Long`	`getLinkSpeed()`
`String`	`getLocalIpAddress()`
`String`	`getLocation()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Long`	`getNewLinkSpeed()`
`String`	`getNote()`
`Long`	`getPeerLinkSpeed()`
`String`	`getPort()`
`String`	`getPortLabel()`
`String`	`getProvider()`
`Long`	`getProviderAccountId()`
`Boolean`	`getRedundancyFlag()`
`String`	`getRemoteIpAddress()`
`String`	`getServiceKey()`
`ServiceType`	`getServiceType()`
`Long`	`getServiceTypeId()`
`String`	`getStatus()`
`String`	`getVendorName()`
`Long`	`getVlanId()`
`String`	`getZoneName()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isBgpAsnSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isErrorMessageSpecified()`
`boolean`	`isGlobalRoutingFlagSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isInterconnectTypeSpecified()`
`boolean`	`isLinkSpeedSpecified()`
`boolean`	`isLocalIpAddressSpecified()`
`boolean`	`isLocationSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNewLinkSpeedSpecified()`
`boolean`	`isNoteSpecified()`
`boolean`	`isPeerLinkSpeedSpecified()`
`boolean`	`isPortSpecified()`
`boolean`	`isProviderAccountIdSpecified()`
`boolean`	`isProviderSpecified()`
`boolean`	`isRedundancyFlagSpecified()`
`boolean`	`isRemoteIpAddressSpecified()`
`boolean`	`isServiceKeySpecified()`
`boolean`	`isServiceTypeIdSpecified()`
`boolean`	`isStatusSpecified()`
`boolean`	`isVlanIdSpecified()`
`static Tenant.Service`	`service(ApiClient client)`
`static Tenant.Service`	`service(ApiClient client, Long id)`
`void`	`setAccountId(Long accountId)`
`void`	`setBgpAsn(Long bgpAsn)`
`void`	`setBillingItem(Interconnect billingItem)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDatacenterName(String datacenterName)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setGlobalRoutingFlag(Boolean globalRoutingFlag)`
`void`	`setId(Long id)`
`void`	`setInterconnectType(String interconnectType)`
`void`	`setLinkSpeed(Long linkSpeed)`
`void`	`setLocalIpAddress(String localIpAddress)`
`void`	`setLocation(String location)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setNewLinkSpeed(Long newLinkSpeed)`
`void`	`setNote(String note)`
`void`	`setPeerLinkSpeed(Long peerLinkSpeed)`
`void`	`setPort(String port)`
`void`	`setPortLabel(String portLabel)`
`void`	`setProvider(String provider)`
`void`	`setProviderAccountId(Long providerAccountId)`
`void`	`setRedundancyFlag(Boolean redundancyFlag)`
`void`	`setRemoteIpAddress(String remoteIpAddress)`
`void`	`setServiceKey(String serviceKey)`
`void`	`setServiceType(ServiceType serviceType)`
`void`	`setServiceTypeId(Long serviceTypeId)`
`void`	`setStatus(String status)`
`void`	`setVendorName(String vendorName)`
`void`	`setVlanId(Long vlanId)`
`void`	`setZoneName(String zoneName)`
`void`	`unsetAccountId()`
`void`	`unsetBgpAsn()`
`void`	`unsetCreateDate()`
`void`	`unsetErrorMessage()`
`void`	`unsetGlobalRoutingFlag()`
`void`	`unsetId()`
`void`	`unsetInterconnectType()`
`void`	`unsetLinkSpeed()`
`void`	`unsetLocalIpAddress()`
`void`	`unsetLocation()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetNewLinkSpeed()`
`void`	`unsetNote()`
`void`	`unsetPeerLinkSpeed()`
`void`	`unsetPort()`
`void`	`unsetProvider()`
`void`	`unsetProviderAccountId()`
`void`	`unsetRedundancyFlag()`
`void`	`unsetRemoteIpAddress()`
`void`	`unsetServiceKey()`
`void`	`unsetServiceTypeId()`
`void`	`unsetStatus()`
`void`	`unsetVlanId()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

billingItem
```
@ApiProperty
protected Interconnect billingItem
```
The active billing item for a network interconnect.

datacenterName

@ApiProperty
protected String datacenterName

portLabel

@ApiProperty
protected String portLabel

serviceType

@ApiProperty
protected ServiceType serviceType

vendorName

@ApiProperty
protected String vendorName

zoneName
```
@ApiProperty
protected String zoneName
```

accountId

@ApiProperty(canBeNullOrNotSet=true)
protected Long accountId

accountIdSpecified
```
protected boolean accountIdSpecified
```

bgpAsn

@ApiProperty(canBeNullOrNotSet=true)
protected Long bgpAsn

Specifies ASN used for BGP.

bgpAsnSpecified
```
protected boolean bgpAsnSpecified
```

createDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar createDate

createDateSpecified
```
protected boolean createDateSpecified
```

errorMessage

@ApiProperty(canBeNullOrNotSet=true)
protected String errorMessage

errorMessageSpecified

protected boolean errorMessageSpecified

globalRoutingFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Boolean globalRoutingFlag
```
The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag = 1 and local connectivity if globalRoutingFlag = 0.

globalRoutingFlagSpecified

protected boolean globalRoutingFlagSpecified

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

idSpecified
```
protected boolean idSpecified
```

interconnectType

@ApiProperty(canBeNullOrNotSet=true)
protected String interconnectType

interconnectTypeSpecified

protected boolean interconnectTypeSpecified

linkSpeed

@ApiProperty(canBeNullOrNotSet=true)
protected Long linkSpeed

Link speed of a Direct Link connection.

linkSpeedSpecified
```
protected boolean linkSpeedSpecified
```

localIpAddress
```
@ApiProperty(canBeNullOrNotSet=true)
protected String localIpAddress
```
IP address (v4 or v6) of "near" router serial interface. No check/update of IP Address table.

localIpAddressSpecified

protected boolean localIpAddressSpecified

location

@ApiProperty(canBeNullOrNotSet=true)
protected String location

locationSpecified
```
protected boolean locationSpecified
```

modifyDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar modifyDate

modifyDateSpecified
```
protected boolean modifyDateSpecified
```

name

@ApiProperty(canBeNullOrNotSet=true)
protected String name

Specifies the Interconnect connection name.

nameSpecified
```
protected boolean nameSpecified
```

newLinkSpeed

@ApiProperty(canBeNullOrNotSet=true)
protected Long newLinkSpeed

Updated Link speed of a Direct Link connection.

newLinkSpeedSpecified

protected boolean newLinkSpeedSpecified

note
```
@ApiProperty(canBeNullOrNotSet=true)
protected String note
```
This field will have the ticket id if the tenant workflow fails

noteSpecified
```
protected boolean noteSpecified
```

peerLinkSpeed

@ApiProperty(canBeNullOrNotSet=true)
protected Long peerLinkSpeed

Link speed of a Direct Link connection on Equinix Side.

peerLinkSpeedSpecified

protected boolean peerLinkSpeedSpecified

port

@ApiProperty(canBeNullOrNotSet=true)
protected String port

portSpecified
```
protected boolean portSpecified
```

provider

@ApiProperty(canBeNullOrNotSet=true)
protected String provider

providerSpecified
```
protected boolean providerSpecified
```

providerAccountId

@ApiProperty(canBeNullOrNotSet=true)
protected Long providerAccountId

providerAccountIdSpecified

protected boolean providerAccountIdSpecified

redundancyFlag

@ApiProperty(canBeNullOrNotSet=true)
protected Boolean redundancyFlag

Specifies redundant connection is available if 1.

redundancyFlagSpecified

protected boolean redundancyFlagSpecified

remoteIpAddress

@ApiProperty(canBeNullOrNotSet=true)
protected String remoteIpAddress

remoteIpAddressSpecified

protected boolean remoteIpAddressSpecified

serviceKey

@ApiProperty(canBeNullOrNotSet=true)
protected String serviceKey

Service key for Interconnect connection.

serviceKeySpecified
```
protected boolean serviceKeySpecified
```

serviceTypeId

@ApiProperty(canBeNullOrNotSet=true)
protected Long serviceTypeId

serviceTypeIdSpecified

protected boolean serviceTypeIdSpecified

status
```
@ApiProperty(canBeNullOrNotSet=true)
protected String status
```
The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CONNECTION_DOWN

statusSpecified
```
protected boolean statusSpecified
```

vlanId

@ApiProperty(canBeNullOrNotSet=true)
protected Long vlanId

vlanIdSpecified
```
protected boolean vlanIdSpecified
```

Constructor Detail
- Tenant
```
public Tenant()
```

Method Detail

getBillingItem
```
public Interconnect getBillingItem()
```

setBillingItem

public void setBillingItem(Interconnect billingItem)

getDatacenterName
```
public String getDatacenterName()
```

setDatacenterName

public void setDatacenterName(String datacenterName)

getPortLabel
```
public String getPortLabel()
```

setPortLabel

public void setPortLabel(String portLabel)

getServiceType
```
public ServiceType getServiceType()
```

setServiceType

public void setServiceType(ServiceType serviceType)

getVendorName
```
public String getVendorName()
```

setVendorName

public void setVendorName(String vendorName)

getZoneName
```
public String getZoneName()
```

setZoneName

public void setZoneName(String zoneName)

getAccountId
```
public Long getAccountId()
```

setAccountId

public void setAccountId(Long accountId)

isAccountIdSpecified
```
public boolean isAccountIdSpecified()
```

unsetAccountId
```
public void unsetAccountId()
```

getBgpAsn
```
public Long getBgpAsn()
```

setBgpAsn

public void setBgpAsn(Long bgpAsn)

isBgpAsnSpecified
```
public boolean isBgpAsnSpecified()
```

unsetBgpAsn
```
public void unsetBgpAsn()
```

getCreateDate

public GregorianCalendar getCreateDate()

setCreateDate

public void setCreateDate(GregorianCalendar createDate)

isCreateDateSpecified

public boolean isCreateDateSpecified()

unsetCreateDate
```
public void unsetCreateDate()
```

getErrorMessage
```
public String getErrorMessage()
```

setErrorMessage

public void setErrorMessage(String errorMessage)

isErrorMessageSpecified

public boolean isErrorMessageSpecified()

unsetErrorMessage
```
public void unsetErrorMessage()
```

getGlobalRoutingFlag
```
public Boolean getGlobalRoutingFlag()
```

setGlobalRoutingFlag

public void setGlobalRoutingFlag(Boolean globalRoutingFlag)

isGlobalRoutingFlagSpecified

public boolean isGlobalRoutingFlagSpecified()

unsetGlobalRoutingFlag
```
public void unsetGlobalRoutingFlag()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getInterconnectType
```
public String getInterconnectType()
```

setInterconnectType

public void setInterconnectType(String interconnectType)

isInterconnectTypeSpecified

public boolean isInterconnectTypeSpecified()

unsetInterconnectType
```
public void unsetInterconnectType()
```

getLinkSpeed
```
public Long getLinkSpeed()
```

setLinkSpeed

public void setLinkSpeed(Long linkSpeed)

isLinkSpeedSpecified
```
public boolean isLinkSpeedSpecified()
```

unsetLinkSpeed
```
public void unsetLinkSpeed()
```

getLocalIpAddress
```
public String getLocalIpAddress()
```

setLocalIpAddress

public void setLocalIpAddress(String localIpAddress)

isLocalIpAddressSpecified

public boolean isLocalIpAddressSpecified()

unsetLocalIpAddress
```
public void unsetLocalIpAddress()
```

getLocation
```
public String getLocation()
```

setLocation

public void setLocation(String location)

isLocationSpecified
```
public boolean isLocationSpecified()
```

unsetLocation
```
public void unsetLocation()
```

getModifyDate

public GregorianCalendar getModifyDate()

setModifyDate

public void setModifyDate(GregorianCalendar modifyDate)

isModifyDateSpecified

public boolean isModifyDateSpecified()

unsetModifyDate
```
public void unsetModifyDate()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getNewLinkSpeed
```
public Long getNewLinkSpeed()
```

setNewLinkSpeed

public void setNewLinkSpeed(Long newLinkSpeed)

isNewLinkSpeedSpecified

public boolean isNewLinkSpeedSpecified()

unsetNewLinkSpeed
```
public void unsetNewLinkSpeed()
```

getNote
```
public String getNote()
```

setNote
```
public void setNote(String note)
```

isNoteSpecified
```
public boolean isNoteSpecified()
```

unsetNote
```
public void unsetNote()
```

getPeerLinkSpeed
```
public Long getPeerLinkSpeed()
```

setPeerLinkSpeed

public void setPeerLinkSpeed(Long peerLinkSpeed)

isPeerLinkSpeedSpecified

public boolean isPeerLinkSpeedSpecified()

unsetPeerLinkSpeed
```
public void unsetPeerLinkSpeed()
```

getPort
```
public String getPort()
```

setPort
```
public void setPort(String port)
```

isPortSpecified
```
public boolean isPortSpecified()
```

unsetPort
```
public void unsetPort()
```

getProvider
```
public String getProvider()
```

setProvider

public void setProvider(String provider)

isProviderSpecified
```
public boolean isProviderSpecified()
```

unsetProvider
```
public void unsetProvider()
```

getProviderAccountId
```
public Long getProviderAccountId()
```

setProviderAccountId

public void setProviderAccountId(Long providerAccountId)

isProviderAccountIdSpecified

public boolean isProviderAccountIdSpecified()

unsetProviderAccountId
```
public void unsetProviderAccountId()
```

getRedundancyFlag
```
public Boolean getRedundancyFlag()
```

setRedundancyFlag

public void setRedundancyFlag(Boolean redundancyFlag)

isRedundancyFlagSpecified

public boolean isRedundancyFlagSpecified()

unsetRedundancyFlag
```
public void unsetRedundancyFlag()
```

getRemoteIpAddress
```
public String getRemoteIpAddress()
```

setRemoteIpAddress

public void setRemoteIpAddress(String remoteIpAddress)

isRemoteIpAddressSpecified

public boolean isRemoteIpAddressSpecified()

unsetRemoteIpAddress
```
public void unsetRemoteIpAddress()
```

getServiceKey
```
public String getServiceKey()
```

setServiceKey

public void setServiceKey(String serviceKey)

isServiceKeySpecified

public boolean isServiceKeySpecified()

unsetServiceKey
```
public void unsetServiceKey()
```

getServiceTypeId
```
public Long getServiceTypeId()
```

setServiceTypeId

public void setServiceTypeId(Long serviceTypeId)

isServiceTypeIdSpecified

public boolean isServiceTypeIdSpecified()

unsetServiceTypeId
```
public void unsetServiceTypeId()
```

getStatus
```
public String getStatus()
```

setStatus

public void setStatus(String status)

isStatusSpecified
```
public boolean isStatusSpecified()
```

unsetStatus
```
public void unsetStatus()
```

getVlanId
```
public Long getVlanId()
```

setVlanId

public void setVlanId(Long vlanId)

isVlanIdSpecified
```
public boolean isVlanIdSpecified()
```

unsetVlanId
```
public void unsetVlanId()
```

asService

public Tenant.Service asService(ApiClient client)

service

public static Tenant.Service service(ApiClient client)

service

public static Tenant.Service service(ApiClient client,
                                     Long id)

Class Tenant

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

billingItem

datacenterName

portLabel

serviceType

vendorName

zoneName

accountId

accountIdSpecified

bgpAsn

bgpAsnSpecified

createDate

createDateSpecified

errorMessage

errorMessageSpecified

globalRoutingFlag

globalRoutingFlagSpecified

id

idSpecified

interconnectType

interconnectTypeSpecified

linkSpeed

linkSpeedSpecified

localIpAddress

localIpAddressSpecified

location

locationSpecified

modifyDate

modifyDateSpecified

name

nameSpecified

newLinkSpeed

newLinkSpeedSpecified

note

noteSpecified

peerLinkSpeed

peerLinkSpeedSpecified

port

portSpecified

provider

providerSpecified

providerAccountId

providerAccountIdSpecified

redundancyFlag

redundancyFlagSpecified

remoteIpAddress

remoteIpAddressSpecified

serviceKey

serviceKeySpecified

serviceTypeId

serviceTypeIdSpecified

status

statusSpecified

vlanId

vlanIdSpecified

Constructor Detail

Tenant

Method Detail

getBillingItem

setBillingItem

getDatacenterName

setDatacenterName

getPortLabel

setPortLabel

getServiceType

setServiceType

getVendorName

setVendorName

getZoneName

setZoneName

getAccountId

setAccountId