Package com.softlayer.api.service.network.customer

Interface Subnet.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Subnet

@ApiService("SoftLayer_Network_Customer_Subnet")
public static interface Subnet.Service
extends Service

Every Customer subnet is defined in the SoftLayer_Network_Customer_Subnet service. SoftLayer keeps track of subnets outside of the SoftLayer Network that are associated to SoftLayer subnets or systems.

For example, customer subnets are tracked for proper management of network tunnels. This service allows for managing subnets on the remote end of the network tunnel.

See Also:

SoftLayer_Network_Customer_Subnet

Method Summary

Modifier and Type	Method	Description
Subnet.ServiceAsync	asAsync()	Get an async version of this service
Subnet	createObject(Subnet templateObject)	For IPSec network tunnels, customers can create their local subnets using this method.
List<IpAddress>	getIpAddresses()	All ip addresses associated with a subnet.
Subnet	getObject()	getObject retrieves the SoftLayer_Network_Customer_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Customer_Subnet service.
void	setMask(Subnet.Mask mask)
Subnet.Mask	withMask()	Use the existing mask on this service or create it if not present
Subnet.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

Subnet.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

Subnet.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(Subnet.Mask mask)

createObject

@ApiMethod Subnet createObject(Subnet templateObject)

For IPSec network tunnels, customers can create their local subnets using this method. After the customer is created successfully, the customer subnet can then be added to the IPSec network tunnel.

See Also:

SoftLayer_Network_Customer_Subnet::createObject

getObject

@ApiMethod(instanceRequired=true) Subnet getObject()

getObject retrieves the SoftLayer_Network_Customer_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Customer_Subnet service. You can only retrieve the subnet whose account matches the account that your portal user is assigned to.

See Also:

SoftLayer_Network_Customer_Subnet::getObject

getIpAddresses

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

All ip addresses associated with a subnet.

See Also:

SoftLayer_Network_Customer_Subnet::getIpAddresses