Package com.softlayer.api.service.network.gateway

Interface Member.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Member

@ApiService("SoftLayer_Network_Gateway_Member")
public static interface Member.Service
extends Service

A network gateway member is a device that serves as a gateway. Once the hardware becomes a member of the gateway, only a reclaim can remove it. A reclaim on the last member of the gateway triggers a reclaim of the entire gateway.

See Also:

SoftLayer_Network_Gateway_Member

Method Summary

Modifier and Type	Method	Description
Member.ServiceAsync	asAsync()	Get an async version of this service
Member	createObject(Member templateObject)	Create a new hardware member on the gateway.
List<Member>	createObjects(List<Member> templateObjects)	Create multiple new hardware members on the gateway.
Attribute	getAttributes()	The attributes for this member.
Hardware	getHardware()	The device for this member.
Gateway	getNetworkGateway()	The gateway this member belongs to.
Member	getObject()
void	setMask(Member.Mask mask)
Member.Mask	withMask()	Use the existing mask on this service or create it if not present
Member.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 Detail

asAsync

Member.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

createObject

@ApiMethod
Member createObject(Member templateObject)

Create a new hardware member on the gateway. This also asynchronously sets up the network for this member. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.

See Also:

SoftLayer_Network_Gateway_Member::createObject

createObjects

@ApiMethod
List<Member> createObjects(List<Member> templateObjects)

Create multiple new hardware members on the gateway. This also asynchronously sets up the network for the members. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.

See Also:

SoftLayer_Network_Gateway_Member::createObjects

getObject

@ApiMethod(instanceRequired=true)
Member getObject()

See Also:

SoftLayer_Network_Gateway_Member::getObject

getAttributes

@ApiMethod(instanceRequired=true)
Attribute getAttributes()

The attributes for this member.

See Also:

SoftLayer_Network_Gateway_Member::getAttributes

getHardware

@ApiMethod(instanceRequired=true)
Hardware getHardware()

The device for this member.

See Also:

SoftLayer_Network_Gateway_Member::getHardware

getNetworkGateway

@ApiMethod(instanceRequired=true)
Gateway getNetworkGateway()

The gateway this member belongs to.

See Also:

SoftLayer_Network_Gateway_Member::getNetworkGateway