Package org.jclouds.softlayer.features

Interface VirtualGuestApi

@Path("/v{jclouds.api-version}")
@Consumes("application/json")
public interface VirtualGuestApi

Provides access to VirtualGuest via their REST API.

See Also:

• invalid input: '<'

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GUEST_MASK
static final String	NOTES_MASK

Method Summary

Modifier and Type	Method	Description
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	getNotes(long id)	Get notes (visible in UI) Don't include it in default getObject mask as it can get quite big (up to 1000 chars).
VirtualGuest	getVirtualGuest(long id)
VirtualGuest	getVirtualGuestFiltered(long id, String filter)	Returns a VirtualGuest with only the fields listed in the filter string.
void	pauseVirtualGuest(long id)	Pause the guest.
void	rebootHardVirtualGuest(long id)	Hard reboot the guest.
void	resumeVirtualGuest(long id)	Resume the guest.
boolean	setNotes(long id, String notes)	Set notes (visible in UI)
boolean	setTags(long id, Set<String> tags)	Set the tags on the instance

Field Details

GUEST_MASK

static final String GUEST_MASK

See Also:

• Constant Field Values

NOTES_MASK

static final String NOTES_MASK

See Also:

• Constant Field Values

Method Details

createVirtualGuest

@Named("VirtualGuests:create")
@POST
@Path("SoftLayer_Virtual_Guest")
@Produces("application/json")
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("VirtualGuests:get")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/getObject")
VirtualGuest getVirtualGuest(@PathParam("id")
 long id)

Parameters:

id - id of the virtual guest

Returns:

virtual guest or null if not found

See Also:

getVirtualGuestFiltered

@Named("VirtualGuests:get")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/getObject")
VirtualGuest getVirtualGuestFiltered(@PathParam("id")
 long id,
 @QueryParam("objectMask")
 String filter)

Returns a VirtualGuest with only the fields listed in the filter string.

Parameters:

id - id of the virtual guest

filter - semicolon separated list of fields to return in the resulting object

Returns:

virtual guest or null if not found

See Also:

deleteVirtualGuest

@Named("VirtualGuests:delete")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/deleteObject")
boolean deleteVirtualGuest(@PathParam("id")
 long id)

Delete a computing instance

Parameters:

id - the id of the virtual guest.

Returns:

the result of the deletion

See Also:

getCreateObjectOptions

@Named("VirtualGuests:getCreateObjectOptions")
@GET
@Path("/SoftLayer_Virtual_Guest/getCreateObjectOptions")
ContainerVirtualGuestConfiguration getCreateObjectOptions()

Determine options available when creating a computing instance

See Also:

rebootHardVirtualGuest

@Named("VirtualGuest:rebootHard")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/rebootHard.json")
void rebootHardVirtualGuest(@PathParam("id")
 long id)

Hard reboot the guest.

Parameters:

id - id of the virtual guest

pauseVirtualGuest

@Named("VirtualGuest:pause")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/pause.json")
void pauseVirtualGuest(@PathParam("id")
 long id)

Pause the guest.

Parameters:

id - id of the virtual guest

resumeVirtualGuest

@Named("VirtualGuest:resume")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/resume.json")
void resumeVirtualGuest(@PathParam("id")
 long id)

Resume the guest.

Parameters:

id - id of the virtual guest

setTags

@Named("VirtualGuest:setTags")
@POST
@Path("/SoftLayer_Virtual_Guest/{id}/setTags")
@Produces("application/json")
boolean setTags(@PathParam("id")
 long id,
 Set<String> tags)

Set the tags on the instance

Parameters:

id - id of the virtual guest

setNotes

@Named("VirtualGuest:setNotes")
@POST
@Path("/SoftLayer_Virtual_Guest/{id}/editObject")
@Produces("application/json")
boolean setNotes(@PathParam("id")
 long id,
 String notes)

Set notes (visible in UI)

Parameters:

id - id of the virtual guest

notes - The notes property to set on the machine - visible in UI

getNotes

@Named("VirtualGuest:getNotes")
@GET
@Path("/SoftLayer_Virtual_Guest/{id}/getObject")
@Produces("application/json")
VirtualGuest getNotes(@PathParam("id")
 long id)

Get notes (visible in UI) Don't include it in default getObject mask as it can get quite big (up to 1000 chars). Also no place to put it in NodeMetadata.

Parameters:

id - id of the virtual guest