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

Interface Component.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Component

@ApiService("SoftLayer_Virtual_Guest_Network_Component")
public static interface Component.Service
extends Service

The virtual guest network component service provides a common interface to a [[SoftLayer_Virtual_Guest|computing instance's]] network component. Interaction with various third party APIs is not needed when implementing this service to administer your computing instances.

See Also:

SoftLayer_Virtual_Guest_Network_Component

Method Summary

Modifier and Type	Method	Description
Component.ServiceAsync	asAsync()	Get an async version of this service
Boolean	disable()	Completely restrict all incoming and outgoing bandwidth traffic to a network component
Boolean	enable()	Allow incoming and outgoing bandwidth traffic to a network component
Guest	getGuest()	The computing instance that this network component exists on.
Boolean	getHighAvailabilityFirewallFlag()
IcpBinding	getIcpBinding()
List<IpAddress>	getIpAddressBindings()	The records of all IP addresses bound to a computing instance's network component.
Firewall	getNetworkComponentFirewall()	The upstream network component firewall.
Vlan	getNetworkVlan()	The VLAN that a computing instance network component's subnet is associated with.
Component	getObject()
String	getPrimaryIpAddress()	A computing instance network component's primary IP address.
IpAddress	getPrimaryIpAddressRecord()
Subnet	getPrimarySubnet()	A network component's subnet for its primary IP address
IpAddress	getPrimaryVersion6IpAddressRecord()	A network component's primary IPv6 IP address record.
Router	getRouter()	A network component's routers.
List<NetworkComponentBinding>	getSecurityGroupBindings()	The bindings associating security groups to this network component
List<Subnet>	getSubnets()	A network component's subnets.
Boolean	isPingable()	Issues a ping command and returns the success (true) or failure (false) of the ping command.
Boolean	securityGroupsReady()
void	setMask(Component.Mask mask)
Component.Mask	withMask()	Use the existing mask on this service or create it if not present
Component.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details

asAsync

Component.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Component.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Component.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Component.Mask mask)

disable

@ApiMethod(instanceRequired=true)
Boolean disable()

Completely restrict all incoming and outgoing bandwidth traffic to a network component

See Also:

SoftLayer_Virtual_Guest_Network_Component::disable

enable

@ApiMethod(instanceRequired=true)
Boolean enable()

Allow incoming and outgoing bandwidth traffic to a network component

See Also:

SoftLayer_Virtual_Guest_Network_Component::enable

getObject

@ApiMethod(instanceRequired=true)
Component getObject()

See Also:

SoftLayer_Virtual_Guest_Network_Component::getObject

isPingable

@ApiMethod(instanceRequired=true)
Boolean isPingable()

Issues a ping command and returns the success (true) or failure (false) of the ping command.

See Also:

SoftLayer_Virtual_Guest_Network_Component::isPingable

securityGroupsReady

@ApiMethod(instanceRequired=true)
Boolean securityGroupsReady()

See Also:

SoftLayer_Virtual_Guest_Network_Component::securityGroupsReady

getGuest

@ApiMethod(instanceRequired=true)
Guest getGuest()

The computing instance that this network component exists on.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getGuest

getHighAvailabilityFirewallFlag

@ApiMethod(instanceRequired=true)
Boolean getHighAvailabilityFirewallFlag()

See Also:

SoftLayer_Virtual_Guest_Network_Component::getHighAvailabilityFirewallFlag

getIcpBinding

@ApiMethod(instanceRequired=true)
IcpBinding getIcpBinding()

See Also:

SoftLayer_Virtual_Guest_Network_Component::getIcpBinding

getIpAddressBindings

@ApiMethod(instanceRequired=true)
List<IpAddress> getIpAddressBindings()

The records of all IP addresses bound to a computing instance's network component.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getIpAddressBindings

getNetworkComponentFirewall

@ApiMethod(instanceRequired=true)
Firewall getNetworkComponentFirewall()

The upstream network component firewall.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getNetworkComponentFirewall

getNetworkVlan

@ApiMethod(instanceRequired=true)
Vlan getNetworkVlan()

The VLAN that a computing instance network component's subnet is associated with.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getNetworkVlan

getPrimaryIpAddress

@ApiMethod(instanceRequired=true)
String getPrimaryIpAddress()

A computing instance network component's primary IP address.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddress

getPrimaryIpAddressRecord

@ApiMethod(instanceRequired=true)
IpAddress getPrimaryIpAddressRecord()

See Also:

SoftLayer_Virtual_Guest_Network_Component::getPrimaryIpAddressRecord

getPrimarySubnet

@ApiMethod(instanceRequired=true)
Subnet getPrimarySubnet()

A network component's subnet for its primary IP address

See Also:

SoftLayer_Virtual_Guest_Network_Component::getPrimarySubnet

getPrimaryVersion6IpAddressRecord

@ApiMethod(instanceRequired=true)
IpAddress getPrimaryVersion6IpAddressRecord()

A network component's primary IPv6 IP address record.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getPrimaryVersion6IpAddressRecord

getRouter

@ApiMethod(instanceRequired=true)
Router getRouter()

A network component's routers.

See Also:

SoftLayer_Virtual_Guest_Network_Component::getRouter

getSecurityGroupBindings

@ApiMethod(instanceRequired=true)
List<NetworkComponentBinding> getSecurityGroupBindings()

The bindings associating security groups to this network component

See Also:

SoftLayer_Virtual_Guest_Network_Component::getSecurityGroupBindings

getSubnets

@ApiMethod(instanceRequired=true)
List<Subnet> getSubnets()

A network component's subnets. A subnet is a group of IP addresses

See Also:

SoftLayer_Virtual_Guest_Network_Component::getSubnets