Field Detail

• 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 Detail

• createVirtualGuest

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

  Parameters:

  id - id of the virtual guest

  Returns:

  virtual guest or null if not found

  See Also:

• getVirtualGuestFiltered

  @Named(value="VirtualGuests:get")
  @GET
  @Path(value="/SoftLayer_Virtual_Guest/{id}/getObject")
  VirtualGuest getVirtualGuestFiltered(@PathParam(value="id")
                                                    long id,
                                                    @QueryParam(value="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(value="VirtualGuests:delete")
  @GET
  @Path(value="/SoftLayer_Virtual_Guest/{id}/deleteObject")
  boolean deleteVirtualGuest(@PathParam(value="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(value="VirtualGuests:getCreateObjectOptions")
  @GET
  @Path(value="/SoftLayer_Virtual_Guest/getCreateObjectOptions")
  ContainerVirtualGuestConfiguration getCreateObjectOptions()

  Determine options available when creating a computing instance

  See Also:

• rebootHardVirtualGuest

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

  Hard reboot the guest.

  Parameters:

  id - id of the virtual guest

• pauseVirtualGuest

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

  Pause the guest.

  Parameters:

  id - id of the virtual guest

• resumeVirtualGuest

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

  Resume the guest.

  Parameters:

  id - id of the virtual guest

• setTags

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

  Set the tags on the instance

  Parameters:

  id - id of the virtual guest

• setNotes

  @Named(value="VirtualGuest:setNotes")
  @POST
  @Path(value="/SoftLayer_Virtual_Guest/{id}/editObject")
  @Produces(value="application/json")
  boolean setNotes(@PathParam(value="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(value="VirtualGuest:getNotes")
  @GET
  @Path(value="/SoftLayer_Virtual_Guest/{id}/getObject")
  @Produces(value="application/json")
  VirtualGuest getNotes(@PathParam(value="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