Method Detail

• listImages

  @Named(value="images:list")
  @GET
  @Path(value="/images/json")
  List<ImageSummary> listImages()

  Returns:

  the images available.

• listImages

  @Named(value="images:list")
  @GET
  @Path(value="/images/json")
  List<ImageSummary> listImages(ListImageOptions options)

  Parameters:

  options - the configuration to list images (@see ListImageOptions)

  Returns:

  the images available.

• inspectImage

  @Named(value="image:inspect")
  @GET
  @Path(value="/images/{name}/json")
  @Nullable
  Image inspectImage(@PathParam(value="name")
                                           String imageName)

  Return low-level information on the image with given name. Not all fields from the returned Image instance are populated by this method (e.g. Image.repoTags()).

  Parameters:

  imageName - The id of the image to inspect.

  Returns:

  low-level information on the image name

• createImage

  @Named(value="image:create")
  @POST
  @Path(value="/images/create")
  InputStream createImage(CreateImageOptions options)

  Create an image, either by pull it from the registry or by importing it

  Parameters:

  options - the configuration to create an image (@see CreateImageOptions)

  Returns:

  a stream of the image creation.

• deleteImage

  @Named(value="image:delete")
  @DELETE
  @Path(value="/images/{name}")
  InputStream deleteImage(@PathParam(value="name")
                                          String name)

  Parameters:

  name - the image name to be deleted

  Returns:

  the stream of the deletion execution.

• deleteImage

  @Named(value="image:delete")
  @DELETE
  @Path(value="/images/{name}")
  InputStream deleteImage(@PathParam(value="name")
                                          String name,
                                          DeleteImageOptions options)

  Parameters:

  name - the name of the image to be removed

  options - the image deletion's options (@see DeleteImageOptions)

  Returns:

  the stream of the deletion execution.

• tagImage

  @Named(value="image:tag")
  @POST
  @Path(value="/images/{name}/tag")
  void tagImage(@PathParam(value="name")
                              String name,
                              @QueryParam(value="repo")
                              String repoName,
                              @QueryParam(value="tag")
                              String tag,
                              @QueryParam(value="force")
                              boolean force)

  Tag the image name into a repository.

  Parameters:

  name - the name of the image to be tagged

  repoName - the repository to tag in

  tag - the new tag name

  force - force create if tag already exists

• getHistory

  @Named(value="image:history")
  @GET
  @Path(value="/images/{name}/history")
  List<ImageHistory> getHistory(@PathParam(value="name")
                                             String name)

  Return the history of the image with given name.

  Parameters:

  name - the name of the image for which the history is retrieved