com.nirima.docker.api

Interface ImagesClient

@Path(value="/images")
public interface ImagesClient

Created by magnayn on 02/02/2014.

Method Summary

Modifier and Type	Method and Description
InputStream	buildImageFromStream(InputStream inputStream, String repositoryName, boolean quiet, boolean nocache) Build an image from Dockerfile via stdin
InputStream	createImage(String fromImage, String fromSrc, String repo, String tag)
InputStream	createImage(String fromImage, String fromSrc, String repo, String tag, String registry)
List<Image>	getImageHistory(String name)
void	insertFile(String name)
ImageInspectResponse	inspectImage(String name)
List<Image>	listImages(String filter, boolean all) List Images
InputStream	pushImageOnRegistry(String name, String registry, String tag)
List<Map<String,String>>	removeImage(String name, boolean force, boolean noprune) Remove an image
List<SearchItem>	searchForImage(String term) Search images
void	tagImage(String name, String repository, boolean force) Tag an image into a repository

Method Detail

listImages

@GET
 @Path(value="/json")
List<Image> listImages(@DefaultValue(value="") @QueryParam(value="filter")
                                                  String filter,
                                                  @QueryParam(value="all")
                                                  boolean all)

List Images

createImage

@POST
 @Path(value="/create")
InputStream createImage(@QueryParam(value="fromImage")
                                                      String fromImage,
                                                      @QueryParam(value="fromSrc")
                                                      String fromSrc,
                                                      @QueryParam(value="repo")
                                                      String repo,
                                                      @QueryParam(value="tag")
                                                      String tag,
                                                      @QueryParam(value="registry")
                                                      String registry)

createImage

@POST
 @Path(value="/create")
InputStream createImage(@QueryParam(value="image")
                                                      String fromImage,
                                                      @QueryParam(value="fromSrc")
                                                      String fromSrc,
                                                      @QueryParam(value="repo")
                                                      String repo,
                                                      @QueryParam(value="tag")
                                                      String tag)

insertFile

@POST
 @Path(value="/{name}/insert")
void insertFile(@PathParam(value="name")
                                                     String name)

inspectImage

@GET
 @Path(value="/{name}/json")
ImageInspectResponse inspectImage(@PathParam(value="name")
                                                                    String name)

getImageHistory

@GET
 @Path(value="/{name}/history")
List<Image> getImageHistory(@PathParam(value="name")
                                                                 String name)

pushImageOnRegistry

@POST
 @Path(value="/{name}/push")
 @Consumes(value="text/plain")
InputStream pushImageOnRegistry(@PathParam(value="name")
                                                                                                  String name,
                                                                                                  @QueryParam(value="registry")
                                                                                                  String registry,
                                                                                                  @QueryParam(value="tag")
                                                                                                  String tag)

tagImage

@POST
 @Path(value="/{name}/tag")
void tagImage(@PathParam(value="name")
                                                String name,
                                                @QueryParam(value="repo")
                                                String repository,
                                                @QueryParam(value="force")
                                                boolean force)

Tag an image into a repository

Parameters:

name -

repository - – The repository to tag in

force -

removeImage

@DELETE
 @Path(value="{name}")
 @Produces(value="text/plain")
List<Map<String,String>> removeImage(@PathParam(value="name")
                                                                                                   String name,
                                                                                                   @QueryParam(value="force")
                                                                                                   boolean force,
                                                                                                   @QueryParam(value="noprune")
                                                                                                   boolean noprune)

Remove an image

Parameters:

name -

Returns:

searchForImage

@GET
 @Path(value="/search")
List<SearchItem> searchForImage(@QueryParam(value="term")
                                                             String term)

Search images

Parameters:

term - - term to search

Returns:

buildImageFromStream

@POST
 @Path(value="/build")
 @Consumes(value="application/tar")
InputStream buildImageFromStream(InputStream inputStream,
                                                                                                  @QueryParam(value="t")
                                                                                                  String repositoryName,
                                                                                                  @QueryParam(value="q")
                                                                                                  boolean quiet,
                                                                                                  @QueryParam(value="nocache")
                                                                                                  boolean nocache)

Build an image from Dockerfile via stdin

Parameters:

inputStream - a tar archive.