io.fabric8.docker.api

Interface Docker

@Produces(value="application/json")
@Consumes(value="application/json")
public interface Docker

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static String	NAME

Method Summary

Methods

Modifier and Type	Method and Description
Object	build(File tarball, String repositoryName, Integer quiet, Integer noCache, Integer remoteIntermediateContainers, Integer forceRemoveIntermediateContainers) Build an image from Dockerfile via stdin
List<Change>	containerChanges(String id)
byte[]	containerCopy(String id, CopySource resource)
ContainerCreateStatus	containerCreate(ContainerConfig config, String name) Create a Container.
byte[]	containerExport(String id)
ContainerInfo	containerInspect(String id)
void	containerKill(String id)
void	containerRemove(String id, Integer v) Remove a container.
void	containerRestart(String id, Integer timeToWait)
byte[]	containerRestart(String id, Integer logs, Integer stream, Integer stdin, Integer stdout, Integer stderr) logs – 1/True/true or 0/False/false, return logs.
List<Container>	containers(Integer all, Integer limit, String since, String before, Integer size) Get the list of Container instances.
void	containerStart(String id, HostConfig hostHostConfig)
void	containerStop(String id, Integer timeToWait)
Top	containerTop(String id)
Status	containerWait(String id)
String	imageCreate(String fromImage, String fromSrc, String repo, String tag, String registry) Create an Image.
List<DeleteInfo>	imageDelete(String name) Remove the image id from the filesystem
List<ImageHistoryItem>	imageHistory(String name) Return the history of the image name.
String	imageInsert(String name, String path, String url) Inserts a file into an image
ImageInfo	imageInspect(String name) Return low-level information on the image name.
Progress	imagePush(String name, String tag, Auth authConfig) Return the history of the image name.
List<Image>	images(Integer all) Get the list of Images.
List<ImageSearchResult>	imageSearch(String term) Search for an image in the docker index.
void	imageTag(String name, String repo, Integer force) Tag an image into a repository
Info	info() Display system-wide information.
Version	version() Show the docker version information

Field Detail

ID

static final String ID

See Also:

Constant Field Values

NAME

static final String NAME

See Also:

Constant Field Values

Method Detail

info

@GET
@Path(value="/info")
Info info()

Display system-wide information.

Returns:

Returns the Info.

version

@GET
@Path(value="/version")
Version version()

Show the docker version information

Returns:

containers

@GET
@Path(value="/containers/json")
List<Container> containers(@QueryParam(value="all")
                                  Integer all,
                                  @QueryParam(value="limit")
                                  Integer limit,
                                  @QueryParam(value="since")
                                  String since,
                                  @QueryParam(value="before")
                                  String before,
                                  @QueryParam(value="size")
                                  Integer size)

Get the list of Container instances.

Parameters:

all - 1/True/true or 0/False/false, Show all containers. Only running containers are shown by default.

limit - Show limit last created containers, include non-running ones.

since - Show only containers created since Id, include non-running ones.

before - Show only containers created before Id, include non-running ones.

size - 1/True/true or 0/False/false, Show the containers sizes.

Returns:

containerInspect

@GET
@Path(value="/container/{id}/json")
ContainerInfo containerInspect(@PathParam(value="id")
                                      String id)

containerCreate

@POST
@Path(value="/container/create")
ContainerCreateStatus containerCreate(ContainerConfig config,
                                              @QueryParam(value="name")
                                              String name)

Create a Container.

Parameters:

config - The container’s configuration

Returns:

containerTop

@GET
@Path(value="/container/{id}/top")
Top containerTop(@PathParam(value="id")
                        String id)

containerChanges

@GET
@Path(value="/container/{id}/changes")
List<Change> containerChanges(@PathParam(value="id")
                                     String id)

containerExport

@GET
@Path(value="/container/{id}/export")
byte[] containerExport(@PathParam(value="id")
                              String id)

containerStart

@POST
@Path(value="/container/{id}/start")
void containerStart(@PathParam(value="id")
                            String id,
                            HostConfig hostHostConfig)

containerStop

@POST
@Path(value="/container/{id}/stop")
void containerStop(@PathParam(value="id")
                           String id,
                           @QueryParam(value="t")
                           Integer timeToWait)

containerRestart

@POST
@Path(value="/container/{id}/restart")
void containerRestart(@PathParam(value="id")
                              String id,
                              @QueryParam(value="t")
                              Integer timeToWait)

containerKill

@POST
@Path(value="/container/{id}/kill")
void containerKill(@PathParam(value="id")
                           String id)

containerRestart

@POST
@Path(value="/container/{id}/attach")
byte[] containerRestart(@PathParam(value="id")
                                String id,
                                @QueryParam(value="logs")
                                Integer logs,
                                @QueryParam(value="stream")
                                Integer stream,
                                @QueryParam(value="stdin")
                                Integer stdin,
                                @QueryParam(value="stdout")
                                Integer stdout,
                                @QueryParam(value="stderr")
                                Integer stderr)

logs – 1/True/true or 0/False/false, return logs. Default false stream – 1/True/true or 0/False/false, return stream. Default false stdin – 1/True/true or 0/False/false, if stream=true, attach to stdin. Default false stdout – 1/True/true or 0/False/false, if logs=true, return stdout log, if stream=true, attach to stdout. Default false stderr – 1/True/true or 0/False/false, if logs=true, return stderr log, if stream=true, attach to stderr. Default false

Parameters:

id -

containerWait

@POST
@Path(value="/container/{id}/wait")
Status containerWait(@PathParam(value="id")
                             String id)

containerRemove

@DELETE
@Path(value="/container/{id}")
void containerRemove(@PathParam(value="id")
                               String id,
                               @QueryParam(value="v")
                               Integer v)

Remove a container.

Parameters:

id - The container id.

v - 1/True/true or 0/False/false, Remove the volumes associated to the container. Default false

containerCopy

@POST
@Path(value="/container/{id}/copy")
byte[] containerCopy(@PathParam(value="id")
                             String id,
                             CopySource resource)

images

@GET
@Path(value="/images/json")
List<Image> images(@QueryParam(value="all")
                          Integer all)

Get the list of Images.

Parameters:

all - 1/True/true or 0/False/false, Show all containers. Only running containers are shown by defaul

Returns:

imageCreate

@POST
@Path(value="/images/create")
String imageCreate(@QueryParam(value="fromImage")
                           String fromImage,
                           @QueryParam(value="formSrc")
                           String fromSrc,
                           @QueryParam(value="repo")
                           String repo,
                           @QueryParam(value="tag")
                           String tag,
                           @QueryParam(value="registry")
                           String registry)

Create an Image.

Parameters:

fromImage - The source image.

fromSrc - The source to import, - means stdin.

repo - The repository.

tag - The tag.

registry - The registry.

Returns:

a sequence of JSON objects for Progress which are not separated by a comma

imageInsert

@POST
@Path(value="/images/{name}/insert")
String imageInsert(@PathParam(value="name")
                           String name,
                           @QueryParam(value="path")
                           String path,
                           @QueryParam(value="url")
                           String url)

Inserts a file into an image

Parameters:

name - the name of the image to insert into

path - the path to write the file

url - the URL of the file to insert

Returns:

a sequence of JSON objects for Progress which are not separated by a comma

imageInspect

@POST
@Path(value="/images/{name}/json")
ImageInfo imageInspect(@PathParam(value="name")
                               String name)

Return low-level information on the image name.

Parameters:

name - The image name.

Returns:

The ImageInfo.

imageHistory

@GET
@Path(value="/images/{name}/history")
List<ImageHistoryItem> imageHistory(@PathParam(value="name")
                                           String name)

Return the history of the image name.

Parameters:

name - The image name.

Returns:

Returns a list of ImageHistoryItem .

imagePush

@POST
@Path(value="/images/{name}/push")
Progress imagePush(@PathParam(value="name")
                           String name,
                           @QueryParam(value="tag")
                           String tag,
                           Auth authConfig)

Return the history of the image name.

Parameters:

name - The image name.

Returns:

Return the Progress

imageTag

@POST
@Path(value="/images/{name}/tag")
void imageTag(@PathParam(value="name")
                      String name,
                      @QueryParam(value="repo")
                      String repo,
                      @QueryParam(value="force")
                      Integer force)

Tag an image into a repository

Parameters:

name - The image name.

repo - The repository to tag in.

force - 1/True/true or 0/False/false, default false.

imageDelete

@DELETE
@Path(value="/images/{name}")
List<DeleteInfo> imageDelete(@PathParam(value="name")
                                       String name)

Remove the image id from the filesystem

Parameters:

name - The image name.

Returns:

Return a list of DeleteInfo

imageSearch

@GET
@Path(value="/images/search")
List<ImageSearchResult> imageSearch(@QueryParam(value="term")
                                           String term)

Search for an image in the docker index.

Parameters:

term - The search term to use.

Returns:

Returns a list of ImageSearchResult.

build

@POST
@Path(value="/build")
Object build(File tarball,
                     @QueryParam(value="t")
                     String repositoryName,
                     @QueryParam(value="q")
                     Integer quiet,
                     @QueryParam(value="nocache")
                     Integer noCache,
                     @QueryParam(value="rm")
                     Integer remoteIntermediateContainers,
                     @QueryParam(value="forcerm")
                     Integer forceRemoveIntermediateContainers)

Build an image from Dockerfile via stdin

Parameters:

repositoryName - the repository name and optional tag to be applied ot the resulting image

quiet - suppress verbose build output

noCache - do not use the cache when building the image

remoteIntermediateContainers - remove intermediate containers after a successful build (default behavior)

forceRemoveIntermediateContainers - always remove intermediate containers (includes rm)