Package com.softlayer.api.service.virtual

Interface PlacementGroup.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

PlacementGroup

@ApiService("SoftLayer_Virtual_PlacementGroup")
public static interface PlacementGroup.Service
extends Service

SoftLayer_Virtual_PlacementGroup is a collection of virtual guests to be placed relative to each other according to a rule.

See Also:

SoftLayer_Virtual_PlacementGroup

Method Summary

Modifier and Type	Method	Description
PlacementGroup.ServiceAsync	asAsync()	Get an async version of this service
PlacementGroup	createObject(PlacementGroup templateObject)	Add a placement group to your account for use during VSI provisioning.
Boolean	deleteObject()	Delete a placement group from your account.
Boolean	editObject(PlacementGroup templateObject)	Update a placement group.
Account	getAccount()	The account that the placement group is implemented on.
List<Hardware>	getAvailableRouters(Long datacenterId)	Returns all routers available for use with placement groups.
Backend	getBackendRouter()	The router the placement group is implemented on.
List<Guest>	getGuests()	The virtual guests that are members of the placement group.
PlacementGroup	getObject()
Rule	getRule()	The placement rule that the placement group is implementing.
void	setMask(PlacementGroup.Mask mask)
PlacementGroup.Mask	withMask()	Use the existing mask on this service or create it if not present
PlacementGroup.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

PlacementGroup.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

createObject

@ApiMethod PlacementGroup createObject(PlacementGroup templateObject)

Add a placement group to your account for use during VSI provisioning.

See Also:

SoftLayer_Virtual_PlacementGroup::createObject

deleteObject

@ApiMethod(instanceRequired=true) Boolean deleteObject()

Delete a placement group from your account.

See Also:

SoftLayer_Virtual_PlacementGroup::deleteObject

editObject

@ApiMethod(instanceRequired=true) Boolean editObject(PlacementGroup templateObject)

Update a placement group.

See Also:

SoftLayer_Virtual_PlacementGroup::editObject

getAvailableRouters

@ApiMethod List<Hardware> getAvailableRouters(Long datacenterId)

Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter.

See Also:

SoftLayer_Virtual_PlacementGroup::getAvailableRouters

getObject

@ApiMethod(instanceRequired=true) PlacementGroup getObject()

See Also:

SoftLayer_Virtual_PlacementGroup::getObject

getAccount

@ApiMethod(instanceRequired=true) Account getAccount()

The account that the placement group is implemented on.

See Also:

SoftLayer_Virtual_PlacementGroup::getAccount

getBackendRouter

@ApiMethod(instanceRequired=true) Backend getBackendRouter()

The router the placement group is implemented on.

See Also:

SoftLayer_Virtual_PlacementGroup::getBackendRouter

getGuests

@ApiMethod(instanceRequired=true) List<Guest> getGuests()

The virtual guests that are members of the placement group.

See Also:

SoftLayer_Virtual_PlacementGroup::getGuests

getRule

@ApiMethod(instanceRequired=true) Rule getRule()

The placement rule that the placement group is implementing.

See Also:

SoftLayer_Virtual_PlacementGroup::getRule