Method Detail

• getImageList

  @GET
  @Path(value="/grid/image/list")
  Set<ServerImage> getImageList(GetImageListOptions... options)

  Returns all server images.

  Parameters:

  options - options to narrow the search down

  Returns:

  server images found

• getImagesById

  @GET
  @Path(value="/grid/image/get")
  Set<ServerImage> getImagesById(Long... ids)

  Returns images, found by specified ids

  Parameters:

  ids - the ids that match existing images

  Returns:

  images found

• getImagesByName

  @GET
  @Path(value="/grid/image/get")
  Set<ServerImage> getImagesByName(String... names)

  Returns images, found by specified names

  Parameters:

  names - the names that march existing images

  Returns:

  images found

• editImageDescription

  @GET
  @Path(value="/grid/image/edit")
  ServerImage editImageDescription(@QueryParam(value="image")
                                          String idOrName,
                                          @QueryParam(value="description")
                                          String newDescription)

  Edits an existing image

  Parameters:

  idOrName - id or name of the existing image

  newDescription - description to replace the current one

  Returns:

  edited server image

• editImageFriendlyName

  @GET
  @Path(value="/grid/image/edit")
  ServerImage editImageFriendlyName(@QueryParam(value="image")
                                           String idOrName,
                                           @QueryParam(value="friendlyName")
                                           String newFriendlyName)

  Edits an existing image

  Parameters:

  idOrName - id or name of the existing image

  newFriendlyName - friendly name to replace the current one

  Returns:

  edited server image

• getDatacenters

  @GET
  @Path(value="/common/lookup/list")
  Set<Option> getDatacenters()

  Retrieves the list of supported Datacenters to save images in. The objects will have datacenter ID, name and description. In most cases, id or name will be used for getImageList(org.jclouds.gogrid.options.GetImageListOptions...).

  Returns:

  supported datacenters

• deleteById

  @GET
  @Path(value="/grid/image/delete")
  ServerImage deleteById(@QueryParam(value="id")
                                long id)

  Deletes an existing image

  Parameters:

  id - id of the existing image

• saveImageFromServer

  @GET
  @Path(value="/grid/image/save")
  ServerImage saveImageFromServer(@QueryParam(value="friendlyName")
                                         String friendlyName,
                                         @QueryParam(value="server")
                                         String idOrName,
                                         SaveImageOptions... options)

  This call will save a private (visible to only you) server image to your library of available images. The image will be saved from an existing server.

  Parameters:

  idOrName - id or name of the existing server

  friendlyName - friendly name of the image

  Returns:

  saved server image