org.jclouds.softlayer.features
Interface VirtualGuestApi

public interface VirtualGuestApi

Provides access to VirtualGuest via their REST API.

See Also:

Field Summary

static String

GUEST_MASK

Method Summary

VirtualGuest	createVirtualGuest(VirtualGuest virtualGuest) Enables the creation of computing instances on an account.
boolean	deleteVirtualGuest(long id) Delete a computing instance
ContainerVirtualGuestConfiguration	getCreateObjectOptions() Determine options available when creating a computing instance
VirtualGuest	getVirtualGuest(long id)
void	pauseVirtualGuest(long id) Pause the guest.
void	rebootHardVirtualGuest(long id) Hard reboot the guest.
void	resumeVirtualGuest(long id) Resume the guest.
boolean	setTags(long id, Set<String> tags) Resume the guest.

Field Detail

GUEST_MASK

static final String GUEST_MASK

See Also:

Constant Field Values

Method Detail

createVirtualGuest

@Named(value="VirtualGuests:create")
VirtualGuest createVirtualGuest(VirtualGuest virtualGuest)

Enables the creation of computing instances on an account.

Parameters:

virtualGuest - this data type presents the structure in which all virtual guests will be presented.

Returns:

the new Virtual Guest

See Also:

getVirtualGuest

@Named(value="VirtualGuests:get")
VirtualGuest getVirtualGuest(long id)

Parameters:

id - id of the virtual guest

Returns:

virtual guest or null if not found

See Also:

deleteVirtualGuest

@Named(value="VirtualGuests:delete")
boolean deleteVirtualGuest(long id)

Delete a computing instance

Parameters:

id - the id of the virtual guest.

Returns:

the result of the deletion

See Also:

getCreateObjectOptions

@Named(value="VirtualGuests:getCreateObjectOptions")
ContainerVirtualGuestConfiguration getCreateObjectOptions()

Determine options available when creating a computing instance

See Also:

rebootHardVirtualGuest

@Named(value="VirtualGuest:rebootHard")
void rebootHardVirtualGuest(long id)

Hard reboot the guest.

Parameters:

id - id of the virtual guest

pauseVirtualGuest

@Named(value="VirtualGuest:pause")
void pauseVirtualGuest(long id)

Pause the guest.

Parameters:

id - id of the virtual guest

resumeVirtualGuest

@Named(value="VirtualGuest:resume")
void resumeVirtualGuest(long id)

Resume the guest.

Parameters:

id - id of the virtual guest

setTags

@Named(value="VirtualGuest:setTags")
boolean setTags(long id,
                      Set<String> tags)

Resume the guest.

Parameters:

id - id of the virtual guest