com.softlayer.api.service.virtual.guest.network.Component

@ApiType("SoftLayer_Virtual_Guest_Network_Component")
public class Component
extends Entity

The virtual guest network component data type presents the structure in which all computing instance network components are presented. Internally, the structure supports various virtualization platforms with no change to external interaction.

A guest, also known as a virtual server, represents an allocation of resources on a virtual host.

See Also:: SoftLayer_Virtual_Guest_Network_Component

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Component.Mask`
`static interface`	`Component.Service`	The virtual guest network component service provides a common interface to a [[SoftLayer_Virtual_Guest\|computing instance's]] network component.
`static interface`	`Component.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected GregorianCalendar`	`createDate`	The date a computing instance's network component was created.
`protected boolean`	`createDateSpecified`
`protected Guest`	`guest`	The computing instance that this network component exists on.
`protected Long`	`guestId`	The unique ID of the [[SoftLayer_Virtual_Guest\|computing instance]] that this network component belongs to.
`protected boolean`	`guestIdSpecified`
`protected Boolean`	`highAvailabilityFirewallFlag`
`protected IcpBinding`	`icpBinding`
`protected Long`	`id`	A computing instance's network component's unique ID.
`protected boolean`	`idSpecified`
`protected Long`	`ipAddressBindingCount`	A count of the records of all IP addresses bound to a computing instance's network component.
`protected List<IpAddress>`	`ipAddressBindings`	The records of all IP addresses bound to a computing instance's network component.
`protected String`	`macAddress`	A computing instance network component's unique MAC address.
`protected boolean`	`macAddressSpecified`
`protected Long`	`maxSpeed`	A computing instance network component's maximum allowed speed, measured in Mbit per second.
`protected boolean`	`maxSpeedSpecified`
`protected GregorianCalendar`	`modifyDate`	The date a computing instance's network component was last modified.
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	A computing instance network component's short name.
`protected boolean`	`nameSpecified`
`protected Firewall`	`networkComponentFirewall`	The upstream network component firewall.
`protected Long`	`networkId`	A computing instance's network component's [[SoftLayer_Virtual_Network\|network]] ID
`protected boolean`	`networkIdSpecified`
`protected Vlan`	`networkVlan`	The VLAN that a computing instance network component's subnet is associated with.
`protected Long`	`port`	A computing instance network component's port number.
`protected boolean`	`portSpecified`
`protected String`	`primaryIpAddress`	A computing instance network component's primary IP address.
`protected IpAddress`	`primaryIpAddressRecord`
`protected Subnet`	`primarySubnet`	A network component's subnet for its primary IP address
`protected IpAddress`	`primaryVersion6IpAddressRecord`	A network component's primary IPv6 IP address record.
`protected Router`	`router`	A network component's routers.
`protected Long`	`securityGroupBindingCount`	A count of the bindings associating security groups to this network component
`protected List<NetworkComponentBinding>`	`securityGroupBindings`	The bindings associating security groups to this network component
`protected Long`	`speed`	A computing instance network component's speed, measured in Mbit per second.
`protected boolean`	`speedSpecified`
`protected String`	`status`	A computing instance network component's status.
`protected boolean`	`statusSpecified`
`protected Long`	`subnetCount`	A count of a network component's subnets.
`protected List<Subnet>`	`subnets`	A network component's subnets.
`protected String`	`uuid`	A computing instance's network component's unique ID on a virtualization platform.
`protected boolean`	`uuidSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Component()

Method Summary

Modifier and Type	Method	Description
`Component.Service`	`asService(ApiClient client)`
`GregorianCalendar`	`getCreateDate()`
`Guest`	`getGuest()`
`Long`	`getGuestId()`
`Boolean`	`getHighAvailabilityFirewallFlag()`
`IcpBinding`	`getIcpBinding()`
`Long`	`getId()`
`Long`	`getIpAddressBindingCount()`
`List<IpAddress>`	`getIpAddressBindings()`
`String`	`getMacAddress()`
`Long`	`getMaxSpeed()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Firewall`	`getNetworkComponentFirewall()`
`Long`	`getNetworkId()`
`Vlan`	`getNetworkVlan()`
`Long`	`getPort()`
`String`	`getPrimaryIpAddress()`
`IpAddress`	`getPrimaryIpAddressRecord()`
`Subnet`	`getPrimarySubnet()`
`IpAddress`	`getPrimaryVersion6IpAddressRecord()`
`Router`	`getRouter()`
`Long`	`getSecurityGroupBindingCount()`
`List<NetworkComponentBinding>`	`getSecurityGroupBindings()`
`Long`	`getSpeed()`
`String`	`getStatus()`
`Long`	`getSubnetCount()`
`List<Subnet>`	`getSubnets()`
`String`	`getUuid()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isGuestIdSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isMacAddressSpecified()`
`boolean`	`isMaxSpeedSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNetworkIdSpecified()`
`boolean`	`isPortSpecified()`
`boolean`	`isSpeedSpecified()`
`boolean`	`isStatusSpecified()`
`boolean`	`isUuidSpecified()`
`static Component.Service`	`service(ApiClient client)`
`static Component.Service`	`service(ApiClient client, Long id)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setGuest(Guest guest)`
`void`	`setGuestId(Long guestId)`
`void`	`setHighAvailabilityFirewallFlag(Boolean highAvailabilityFirewallFlag)`
`void`	`setIcpBinding(IcpBinding icpBinding)`
`void`	`setId(Long id)`
`void`	`setIpAddressBindingCount(Long ipAddressBindingCount)`
`void`	`setMacAddress(String macAddress)`
`void`	`setMaxSpeed(Long maxSpeed)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setNetworkComponentFirewall(Firewall networkComponentFirewall)`
`void`	`setNetworkId(Long networkId)`
`void`	`setNetworkVlan(Vlan networkVlan)`
`void`	`setPort(Long port)`
`void`	`setPrimaryIpAddress(String primaryIpAddress)`
`void`	`setPrimaryIpAddressRecord(IpAddress primaryIpAddressRecord)`
`void`	`setPrimarySubnet(Subnet primarySubnet)`
`void`	`setPrimaryVersion6IpAddressRecord(IpAddress primaryVersion6IpAddressRecord)`
`void`	`setRouter(Router router)`
`void`	`setSecurityGroupBindingCount(Long securityGroupBindingCount)`
`void`	`setSpeed(Long speed)`
`void`	`setStatus(String status)`
`void`	`setSubnetCount(Long subnetCount)`
`void`	`setUuid(String uuid)`
`void`	`unsetCreateDate()`
`void`	`unsetGuestId()`
`void`	`unsetId()`
`void`	`unsetMacAddress()`
`void`	`unsetMaxSpeed()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetNetworkId()`
`void`	`unsetPort()`
`void`	`unsetSpeed()`
`void`	`unsetStatus()`
`void`	`unsetUuid()`

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 Details
- guest
  
  @ApiProperty protected Guest guest
  
  The computing instance that this network component exists on.
- highAvailabilityFirewallFlag
  
  @ApiProperty protected Boolean highAvailabilityFirewallFlag
- icpBinding
  
  @ApiProperty protected IcpBinding icpBinding
- ipAddressBindings
  
  @ApiProperty protected List<IpAddress> ipAddressBindings
  
  The records of all IP addresses bound to a computing instance's network component.
- networkComponentFirewall
  
  @ApiProperty protected Firewall networkComponentFirewall
  
  The upstream network component firewall.
- networkVlan
  
  @ApiProperty protected Vlan networkVlan
  
  The VLAN that a computing instance network component's subnet is associated with.
- primaryIpAddress
  
  @ApiProperty protected String primaryIpAddress
  
  A computing instance network component's primary IP address.
- primaryIpAddressRecord
  
  @ApiProperty protected IpAddress primaryIpAddressRecord
- primarySubnet
  
  @ApiProperty protected Subnet primarySubnet
  
  A network component's subnet for its primary IP address
- primaryVersion6IpAddressRecord
  
  @ApiProperty protected IpAddress primaryVersion6IpAddressRecord
  
  A network component's primary IPv6 IP address record.
- router
  
  @ApiProperty protected Router router
  
  A network component's routers.
- securityGroupBindings
  
  @ApiProperty protected List<NetworkComponentBinding> securityGroupBindings
  
  The bindings associating security groups to this network component
- subnets
  
  @ApiProperty protected List<Subnet> subnets
  
  A network component's subnets. A subnet is a group of IP addresses
- createDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
  
  The date a computing instance's network component was created.
- createDateSpecified
  
  protected boolean createDateSpecified
- guestId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long guestId
  
  The unique ID of the [[SoftLayer_Virtual_Guest|computing instance]] that this network component belongs to.
- guestIdSpecified
  
  protected boolean guestIdSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  A computing instance's network component's unique ID.
- idSpecified
  
  protected boolean idSpecified
- macAddress
  
  @ApiProperty(canBeNullOrNotSet=true) protected String macAddress
  
  A computing instance network component's unique MAC address.
- macAddressSpecified
  
  protected boolean macAddressSpecified
- maxSpeed
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long maxSpeed
  
  A computing instance network component's maximum allowed speed, measured in Mbit per second. ''maxSpeed'' is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer computing instance.
- maxSpeedSpecified
  
  protected boolean maxSpeedSpecified
- modifyDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
  
  The date a computing instance's network component was last modified.
- modifyDateSpecified
  
  protected boolean modifyDateSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  A computing instance network component's short name. This is usually ''eth''. Use this in conjunction with the ''port'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
- nameSpecified
  
  protected boolean nameSpecified
- networkId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long networkId
  
  A computing instance's network component's [[SoftLayer_Virtual_Network|network]] ID
- networkIdSpecified
  
  protected boolean networkIdSpecified
- port
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long port
  
  A computing instance network component's port number. Most computing instances have more than one network interface. The port property separates these interfaces. Use this in conjunction with the ''name'' property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.
- portSpecified
  
  protected boolean portSpecified
- speed
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long speed
  
  A computing instance network component's speed, measured in Mbit per second.
- speedSpecified
  
  protected boolean speedSpecified
- status
  
  @ApiProperty(canBeNullOrNotSet=true) protected String status
  
  A computing instance network component's status. This can be one of four possible values: "ACTIVE", "DISABLED", "INACTIVE", or "ABUSE_DISCONNECT". "ACTIVE" network components are enabled and in use on a cloud instance. "ABUSE_DISCONNECT" status components have been administratively disabled by SoftLayer accounting or abuse. "DISABLED" components have been administratively disabled by you, the user. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support.
- statusSpecified
  
  protected boolean statusSpecified
- uuid
  
  @ApiProperty(canBeNullOrNotSet=true) protected String uuid
  
  A computing instance's network component's unique ID on a virtualization platform.
- uuidSpecified
  
  protected boolean uuidSpecified
- ipAddressBindingCount
  
  @ApiProperty protected Long ipAddressBindingCount
  
  A count of the records of all IP addresses bound to a computing instance's network component.
- securityGroupBindingCount
  
  @ApiProperty protected Long securityGroupBindingCount
  
  A count of the bindings associating security groups to this network component
- subnetCount
  
  @ApiProperty protected Long subnetCount
  
  A count of a network component's subnets. A subnet is a group of IP addresses
Constructor Details
- Component
  
  public Component()
Method Details
- getGuest
  
  public Guest getGuest()
- setGuest
  
  public void setGuest(Guest guest)
- getHighAvailabilityFirewallFlag
  
  public Boolean getHighAvailabilityFirewallFlag()
- setHighAvailabilityFirewallFlag
  
  public void setHighAvailabilityFirewallFlag(Boolean highAvailabilityFirewallFlag)
- getIcpBinding
  
  public IcpBinding getIcpBinding()
- setIcpBinding
  
  public void setIcpBinding(IcpBinding icpBinding)
- getIpAddressBindings
  
  public List<IpAddress> getIpAddressBindings()
- getNetworkComponentFirewall
  
  public Firewall getNetworkComponentFirewall()
- setNetworkComponentFirewall
  
  public void setNetworkComponentFirewall(Firewall networkComponentFirewall)
- getNetworkVlan
  
  public Vlan getNetworkVlan()
- setNetworkVlan
  
  public void setNetworkVlan(Vlan networkVlan)
- getPrimaryIpAddress
  
  public String getPrimaryIpAddress()
- setPrimaryIpAddress
  
  public void setPrimaryIpAddress(String primaryIpAddress)
- getPrimaryIpAddressRecord
  
  public IpAddress getPrimaryIpAddressRecord()
- setPrimaryIpAddressRecord
  
  public void setPrimaryIpAddressRecord(IpAddress primaryIpAddressRecord)
- getPrimarySubnet
  
  public Subnet getPrimarySubnet()
- setPrimarySubnet
  
  public void setPrimarySubnet(Subnet primarySubnet)
- getPrimaryVersion6IpAddressRecord
  
  public IpAddress getPrimaryVersion6IpAddressRecord()
- setPrimaryVersion6IpAddressRecord
  
  public void setPrimaryVersion6IpAddressRecord(IpAddress primaryVersion6IpAddressRecord)
- getRouter
  
  public Router getRouter()
- setRouter
  
  public void setRouter(Router router)
- getSecurityGroupBindings
  
  public List<NetworkComponentBinding> getSecurityGroupBindings()
- getSubnets
  
  public List<Subnet> getSubnets()
- getCreateDate
  
  public GregorianCalendar getCreateDate()
- setCreateDate
  
  public void setCreateDate(GregorianCalendar createDate)
- isCreateDateSpecified
  
  public boolean isCreateDateSpecified()
- unsetCreateDate
  
  public void unsetCreateDate()
- getGuestId
  
  public Long getGuestId()
- setGuestId
  
  public void setGuestId(Long guestId)
- isGuestIdSpecified
  
  public boolean isGuestIdSpecified()
- unsetGuestId
  
  public void unsetGuestId()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getMacAddress
  
  public String getMacAddress()
- setMacAddress
  
  public void setMacAddress(String macAddress)
- isMacAddressSpecified
  
  public boolean isMacAddressSpecified()
- unsetMacAddress
  
  public void unsetMacAddress()
- getMaxSpeed
  
  public Long getMaxSpeed()
- setMaxSpeed
  
  public void setMaxSpeed(Long maxSpeed)
- isMaxSpeedSpecified
  
  public boolean isMaxSpeedSpecified()
- unsetMaxSpeed
  
  public void unsetMaxSpeed()
- 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()
- getNetworkId
  
  public Long getNetworkId()
- setNetworkId
  
  public void setNetworkId(Long networkId)
- isNetworkIdSpecified
  
  public boolean isNetworkIdSpecified()
- unsetNetworkId
  
  public void unsetNetworkId()
- getPort
  
  public Long getPort()
- setPort
  
  public void setPort(Long port)
- isPortSpecified
  
  public boolean isPortSpecified()
- unsetPort
  
  public void unsetPort()
- getSpeed
  
  public Long getSpeed()
- setSpeed
  
  public void setSpeed(Long speed)
- isSpeedSpecified
  
  public boolean isSpeedSpecified()
- unsetSpeed
  
  public void unsetSpeed()
- getStatus
  
  public String getStatus()
- setStatus
  
  public void setStatus(String status)
- isStatusSpecified
  
  public boolean isStatusSpecified()
- unsetStatus
  
  public void unsetStatus()
- getUuid
  
  public String getUuid()
- setUuid
  
  public void setUuid(String uuid)
- isUuidSpecified
  
  public boolean isUuidSpecified()
- unsetUuid
  
  public void unsetUuid()
- getIpAddressBindingCount
  
  public Long getIpAddressBindingCount()
- setIpAddressBindingCount
  
  public void setIpAddressBindingCount(Long ipAddressBindingCount)
- getSecurityGroupBindingCount
  
  public Long getSecurityGroupBindingCount()
- setSecurityGroupBindingCount
  
  public void setSecurityGroupBindingCount(Long securityGroupBindingCount)
- getSubnetCount
  
  public Long getSubnetCount()
- setSubnetCount
  
  public void setSubnetCount(Long subnetCount)
- asService
  
  public Component.Service asService(ApiClient client)
- service
  
  public static Component.Service service(ApiClient client)
- service
  
  public static Component.Service service(ApiClient client, Long id)

Class Component

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 Details

Constructor Details

Method Details