Package com.softlayer.api.service.virtual

Interface DedicatedHost.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

DedicatedHost

@ApiService("SoftLayer_Virtual_DedicatedHost")
public static interface DedicatedHost.Service
extends Service

SoftLayer_Virtual_DedicatedHost models a single tenant virtual host dedicated to a specific account.

See Also:

SoftLayer_Virtual_DedicatedHost

Method Summary

Modifier and Type	Method	Description
DedicatedHost.ServiceAsync	asAsync()	Get an async version of this service
Boolean	deleteObject()	This method will cancel a dedicated host immediately.
Boolean	editObject(DedicatedHost templateObject)	Edit a dedicated host's properties.
Account	getAccount()	The account that the dedicated host belongs to.
AllocationStatus	getAllocationStatus()	The container that represents allocations on the dedicated host.
List<Hardware>	getAvailableRouters(DedicatedHost dedicatedHost)	This method will get the available backend routers to order a dedicated host.
Backend	getBackendRouter()	The backend router behind dedicated host's pool of resources.
DedicatedHost	getBillingItem()	The billing item for the dedicated host.
Location	getDatacenter()	The datacenter that the dedicated host resides in.
List<Guest>	getGuests()	The guests associated with the dedicated host.
List<Reference>	getInternalTagReferences()
DedicatedHost	getObject()
AllocationStatus	getPciDeviceAllocationStatus()	The container that represents PCI device allocations on the dedicated host.
List<PciDevice>	getPciDevices()	A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.
List<Reference>	getTagReferences()
void	setMask(DedicatedHost.Mask mask)
Boolean	setTags(String tags)
DedicatedHost.Mask	withMask()	Use the existing mask on this service or create it if not present
DedicatedHost.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

DedicatedHost.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

deleteObject

@ApiMethod(instanceRequired=true)
Boolean deleteObject()

This method will cancel a dedicated host immediately.

See Also:

SoftLayer_Virtual_DedicatedHost::deleteObject

editObject

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

Edit a dedicated host's properties.

See Also:

SoftLayer_Virtual_DedicatedHost::editObject

getAvailableRouters

@ApiMethod
List<Hardware> getAvailableRouters(DedicatedHost dedicatedHost)

This method will get the available backend routers to order a dedicated host.

See Also:

SoftLayer_Virtual_DedicatedHost::getAvailableRouters

getObject

@ApiMethod(instanceRequired=true)
DedicatedHost getObject()

See Also:

SoftLayer_Virtual_DedicatedHost::getObject

setTags

@ApiMethod(instanceRequired=true)
Boolean setTags(String tags)

See Also:

SoftLayer_Virtual_DedicatedHost::setTags

getAccount

@ApiMethod(instanceRequired=true)
Account getAccount()

The account that the dedicated host belongs to.

See Also:

SoftLayer_Virtual_DedicatedHost::getAccount

getAllocationStatus

@ApiMethod(instanceRequired=true)
AllocationStatus getAllocationStatus()

The container that represents allocations on the dedicated host.

See Also:

SoftLayer_Virtual_DedicatedHost::getAllocationStatus

getBackendRouter

@ApiMethod(instanceRequired=true)
Backend getBackendRouter()

The backend router behind dedicated host's pool of resources.

See Also:

SoftLayer_Virtual_DedicatedHost::getBackendRouter

getBillingItem

@ApiMethod(instanceRequired=true)
DedicatedHost getBillingItem()

The billing item for the dedicated host.

See Also:

SoftLayer_Virtual_DedicatedHost::getBillingItem

getDatacenter

@ApiMethod(instanceRequired=true)
Location getDatacenter()

The datacenter that the dedicated host resides in.

See Also:

SoftLayer_Virtual_DedicatedHost::getDatacenter

getGuests

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

The guests associated with the dedicated host.

See Also:

SoftLayer_Virtual_DedicatedHost::getGuests

getInternalTagReferences

@ApiMethod(instanceRequired=true)
List<Reference> getInternalTagReferences()

See Also:

SoftLayer_Virtual_DedicatedHost::getInternalTagReferences

getPciDeviceAllocationStatus

@ApiMethod(instanceRequired=true)
AllocationStatus getPciDeviceAllocationStatus()

The container that represents PCI device allocations on the dedicated host.

See Also:

SoftLayer_Virtual_DedicatedHost::getPciDeviceAllocationStatus

getPciDevices

@ApiMethod(instanceRequired=true)
List<PciDevice> getPciDevices()

A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.

See Also:

SoftLayer_Virtual_DedicatedHost::getPciDevices

getTagReferences

@ApiMethod(instanceRequired=true)
List<Reference> getTagReferences()

See Also:

SoftLayer_Virtual_DedicatedHost::getTagReferences