org.jclouds.softlayer.features

Interface VirtualGuestClient

public interface VirtualGuestClient

Provides synchronous access to VirtualGuest.

Author:

Adrian Cole

See Also:

VirtualGuestAsyncClient,

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancelService(long id) Cancel the resource or service for a billing Item
ProductOrder	getOrderTemplate(long id) Obtain an order container that is ready to be sent to the orderVirtualGuest method.
VirtualGuest	getVirtualGuest(long id)
Set<VirtualGuest>	listVirtualGuests()
ProductOrderReceipt	orderVirtualGuest(ProductOrder order) Use this method for placing server orders and additional services orders.
void	pauseVirtualGuest(long id) pause the guest.
void	powerOffVirtualGuest(long id) Power off a guest
void	powerOnVirtualGuest(long id) Power on a guest
void	rebootHardVirtualGuest(long id) hard reboot the guest.
void	resumeVirtualGuest(long id) resume the guest.

Method Detail

listVirtualGuests

Set<VirtualGuest> listVirtualGuests()

Returns:

an account's associated virtual guest objects.

getVirtualGuest

VirtualGuest getVirtualGuest(long id)

Parameters:

id - id of the virtual guest

Returns:

virtual guest or null if not found

rebootHardVirtualGuest

void rebootHardVirtualGuest(long id)

hard reboot the guest.

Parameters:

id - id of the virtual guest

powerOffVirtualGuest

void powerOffVirtualGuest(long id)

Power off a guest

Parameters:

id - id of the virtual guest

powerOnVirtualGuest

void powerOnVirtualGuest(long id)

Power on a guest

Parameters:

id - id of the virtual guest

pauseVirtualGuest

void pauseVirtualGuest(long id)

pause the guest.

Parameters:

id - id of the virtual guest

resumeVirtualGuest

void resumeVirtualGuest(long id)

resume the guest.

Parameters:

id - id of the virtual guest

cancelService

boolean cancelService(long id)

Cancel the resource or service for a billing Item

Parameters:

id - The id of the billing item to cancel

Returns:

true or false

orderVirtualGuest

ProductOrderReceipt orderVirtualGuest(ProductOrder order)

Use this method for placing server orders and additional services orders.

Parameters:

order - Details required to order.

Returns:

A receipt for the order

See Also:

getOrderTemplate

ProductOrder getOrderTemplate(long id)

Obtain an order container that is ready to be sent to the orderVirtualGuest method. This container will include all services that the selected computing instance has. If desired you may remove prices which were returned.

Parameters:

id - The id of the existing Virtual Guest

Returns:

The ProductOrder used to create the VirtualGust or null if not available

See Also: