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

Class 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

    • Field Detail

      • guest

        @ApiProperty
protected Guest guest
        The computing instance that this network component exists on.

      • 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.

      • 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.

      • subnets

        @ApiProperty
protected List<Subnet> subnets
        A network component's subnets. A subnet is a group of IP addresses

      • 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

      • idSpecified

        protected boolean idSpecified

      • 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

      • 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

      • 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

      • 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

      • 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 Detail

      • Component

        public Component()

    • Method Detail

      • 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)

      • 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()

      • 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)