@Produces(value="application/json")
@Consumes(value="application/json")
public interface Docker
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID |
static java.lang.String |
NAME |
Modifier and Type | Method and Description |
---|---|
java.util.List<Change> |
containerChanges(java.lang.String id) |
byte[] |
containerCopy(java.lang.String id,
CopySource resource) |
ContainerCreateStatus |
containerCreate(ContainerConfig config,
java.lang.String name)
Create a
Container . |
byte[] |
containerExport(java.lang.String id) |
ContainerInfo |
containerInspect(java.lang.String id) |
void |
containerKill(java.lang.String id) |
void |
containerRemove(java.lang.String id,
java.lang.Integer v)
Remove a container.
|
void |
containerRestart(java.lang.String id,
java.lang.Integer timeToWait) |
byte[] |
containerRestart(java.lang.String id,
java.lang.Integer logs,
java.lang.Integer stream,
java.lang.Integer stdin,
java.lang.Integer stdout,
java.lang.Integer stderr)
logs – 1/True/true or 0/False/false, return logs.
|
java.util.List<Container> |
containers(java.lang.Integer all,
java.lang.Integer limit,
java.lang.String since,
java.lang.String before,
java.lang.Integer size)
Get the list of
Container instances. |
void |
containerStart(java.lang.String id,
HostConfig hostHostConfig) |
void |
containerStop(java.lang.String id,
java.lang.Integer timeToWait) |
Top |
containerTop(java.lang.String id) |
Status |
containerWait(java.lang.String id) |
java.lang.String |
imageCreate(java.lang.String fromImage,
java.lang.String fromSrc,
java.lang.String repo,
java.lang.String tag,
java.lang.String registry)
Create an
Image . |
java.util.List<DeleteInfo> |
imageDelete(java.lang.String name)
Remove the image id from the filesystem
|
java.util.List<ImageHistoryItem> |
imageHistory(java.lang.String name)
Return the history of the image name.
|
java.lang.String |
imageInsert(java.lang.String name,
java.lang.String path,
java.lang.String url)
Inserts a file into an image
|
ImageInfo |
imageInspect(java.lang.String name)
Return low-level information on the image name.
|
Progress |
imagePush(java.lang.String name,
java.lang.String registry,
Auth authConfig)
Return the history of the image name.
|
java.util.List<Image> |
images(java.lang.Integer all)
Get the list of
Image s. |
java.util.List<ImageSearchResult> |
imageSearch(java.lang.String term)
Search for an image in the docker index.
|
void |
imageTag(java.lang.String name,
java.lang.String repo,
java.lang.Integer force)
Tag an image into a repository
|
Info |
info()
Display system-wide information.
|
Version |
version()
Show the docker version information
|
static final java.lang.String ID
static final java.lang.String NAME
@GET @Path(value="/info") Info info()
Info
.@GET @Path(value="/version") Version version()
@GET @Path(value="/containers/json") java.util.List<Container> containers(@QueryParam(value="all") java.lang.Integer all, @QueryParam(value="limit") java.lang.Integer limit, @QueryParam(value="since") java.lang.String since, @QueryParam(value="before") java.lang.String before, @QueryParam(value="size") java.lang.Integer size)
Container
instances.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.@GET @Path(value="/containers/{id}/json") ContainerInfo containerInspect(@PathParam(value="id") java.lang.String id)
@POST @Path(value="/containers/create") ContainerCreateStatus containerCreate(ContainerConfig config, @QueryParam(value="name") java.lang.String name)
Container
.config
- The container’s configuration@GET @Path(value="/containers/{id}/top") Top containerTop(@PathParam(value="id") java.lang.String id)
@GET @Path(value="/containers/{id}/changes") java.util.List<Change> containerChanges(@PathParam(value="id") java.lang.String id)
@GET @Path(value="/containers/{id}/export") byte[] containerExport(@PathParam(value="id") java.lang.String id)
@POST @Path(value="/containers/{id}/start") void containerStart(@PathParam(value="id") java.lang.String id, HostConfig hostHostConfig)
@POST @Path(value="/containers/{id}/stop") void containerStop(@PathParam(value="id") java.lang.String id, @QueryParam(value="t") java.lang.Integer timeToWait)
@POST @Path(value="/containers/{id}/restart") void containerRestart(@PathParam(value="id") java.lang.String id, @QueryParam(value="t") java.lang.Integer timeToWait)
@POST @Path(value="/containers/{id}/kill") void containerKill(@PathParam(value="id") java.lang.String id)
@POST @Path(value="/containers/{id}/attach") byte[] containerRestart(@PathParam(value="id") java.lang.String id, @QueryParam(value="logs") java.lang.Integer logs, @QueryParam(value="stream") java.lang.Integer stream, @QueryParam(value="stdin") java.lang.Integer stdin, @QueryParam(value="stdout") java.lang.Integer stdout, @QueryParam(value="stderr") java.lang.Integer stderr)
id
- @POST @Path(value="/containers/{id}/wait") Status containerWait(@PathParam(value="id") java.lang.String id)
@DELETE @Path(value="/containers/{id}") void containerRemove(@PathParam(value="id") java.lang.String id, @QueryParam(value="v") java.lang.Integer v)
id
- The container id.v
- 1/True/true or 0/False/false, Remove the volumes associated to the container. Default false@POST @Path(value="/containers/{id}/copy") byte[] containerCopy(@PathParam(value="id") java.lang.String id, CopySource resource)
@GET @Path(value="/images/json") java.util.List<Image> images(@QueryParam(value="all") java.lang.Integer all)
Image
s.all
- 1/True/true or 0/False/false, Show all containers. Only running containers are shown by defaul@POST @Path(value="/images/create") java.lang.String imageCreate(@QueryParam(value="fromImage") java.lang.String fromImage, @QueryParam(value="formSrc") java.lang.String fromSrc, @QueryParam(value="repo") java.lang.String repo, @QueryParam(value="tag") java.lang.String tag, @QueryParam(value="registry") java.lang.String registry)
Image
.fromImage
- The source image.fromSrc
- The source to import, - means stdin.repo
- The repository.tag
- The tag.registry
- The registry.Progress
which are not separated by a comma@POST @Path(value="/images/{name}/insert") java.lang.String imageInsert(@PathParam(value="name") java.lang.String name, @QueryParam(value="path") java.lang.String path, @QueryParam(value="url") java.lang.String url)
name
- the name of the image to insert intopath
- the path to write the fileurl
- the URL of the file to insertProgress
which are not separated by a comma@POST @Path(value="/images/{name}/json") ImageInfo imageInspect(@PathParam(value="name") java.lang.String name)
name
- The image name.ImageInfo
.@GET @Path(value="/images/{name}/history") java.util.List<ImageHistoryItem> imageHistory(@PathParam(value="name") java.lang.String name)
name
- The image name.ImageHistoryItem
.@POST @Path(value="/images/{name}/push") Progress imagePush(@PathParam(value="name") java.lang.String name, @QueryParam(value="registry") java.lang.String registry, Auth authConfig)
name
- The image name.Progress
@POST @Path(value="/images/{name}/tag") void imageTag(@PathParam(value="name") java.lang.String name, @QueryParam(value="repo") java.lang.String repo, @QueryParam(value="force") java.lang.Integer force)
name
- The image name.repo
- The repository to tag in.force
- 1/True/true or 0/False/false, default false.@DELETE @Path(value="/images/{name}") java.util.List<DeleteInfo> imageDelete(@PathParam(value="name") java.lang.String name)
name
- The image name.DeleteInfo
@GET @Path(value="/images/search") java.util.List<ImageSearchResult> imageSearch(@QueryParam(value="term") java.lang.String term)
term
- The search term to use.ImageSearchResult
.Copyright © 2014 Red Hat. All Rights Reserved.