Method Detail

• list

  @Named(value="image:list")
  @GET
  PagedIterable<Resource> list()

  List all images (IDs, names, links)

  Returns:

  all images (IDs, names, links)

• list

  @Named(value="image:list")
  @GET
  PaginatedCollection<Resource> list(PaginationOptions options)

• listInDetail

  @Named(value="image:list")
  @GET
  @Path(value="/detail")
  PagedIterable<Image> listInDetail()

  List all images (all details)

  Returns:

  all images (all details)

• listInDetail

  @Named(value="image:list")
  @GET
  @Path(value="/detail")
  PaginatedCollection<Image> listInDetail(PaginationOptions options)

• get

  @Named(value="image:get")
  @GET
  @Path(value="/{id}")
  @Nullable
  Image get(@PathParam(value="id")
                                  String id)

  List details of the specified image

  Parameters:

  id - id of the server

  Returns:

  server or null if not found

• delete

  @Named(value="image:delete")
  @DELETE
  @Path(value="/{id}")
  void delete(@PathParam(value="id")
                              String id)

  Delete the specified image

  Parameters:

  id - id of the image

• getMetadata

  @Named(value="image:getMetadata")
  @GET
  @Path(value="/{id}/metadata")
  Map<String,String> getMetadata(@PathParam(value="id")
                                              String id)

  List all metadata for an image.

  Parameters:

  id - id of the image

  Returns:

  the metadata as a Map

• setMetadata

  @Named(value="image:setMetadata")
  @PUT
  @Path(value="/{id}/metadata")
  @Produces(value="application/json")
  Map<String,String> setMetadata(@PathParam(value="id")
                                                       String id,
                                                       Map<String,String> metadata)

  Sets the metadata for an image.

  Parameters:

  id - id of the image

  metadata - a Map containing the metadata

  Returns:

  the metadata as a Map

• updateMetadata

  @Named(value="image:updateMetadata")
  @POST
  @Path(value="/{id}/metadata")
  @Produces(value="application/json")
  Map<String,String> updateMetadata(@PathParam(value="id")
                                                           String id,
                                                           Map<String,String> metadata)

  Update the metadata for a server.

  Parameters:

  id - id of the image

  metadata - a Map containing the metadata

  Returns:

  the metadata as a Map

• getMetadata

  @Named(value="image:getMetadata")
  @GET
  @Path(value="/{id}/metadata/{key}")
  @Nullable
  String getMetadata(@PathParam(value="id")
                                           String id,
                                           @PathParam(value="key")
                                           String key)

  Update the metadata for an image.

  Parameters:

  id - id of the image

  metadata - a Map containing the metadata

  Returns:

  the value or null if not present

• updateMetadata

  @Named(value="image:updateMetadata")
  @PUT
  @Path(value="/{id}/metadata/{key}")
  @Nullable
  String updateMetadata(@PathParam(value="id")
                                              String id,
                                              @PathParam(value="key")
                                              String key,
                                              @PathParam(value="value")
                                              String value)

  Set a metadata item for an image.

  Parameters:

  id - id of the image

  key - the name of the metadata item

  value - the value of the metadata item

  Returns:

  the value you updated

• deleteMetadata

  @Named(value="image:deleteMetadata")
  @DELETE
  @Path(value="/{id}/metadata/{key}")
  void deleteMetadata(@PathParam(value="id")
                                      String id,
                                      @PathParam(value="key")
                                      String key)

  Delete a metadata item from an image.

  Parameters:

  id - id of the image

  key - the name of the metadata item