| Package | Description |
|---|---|
| com.spotify.docker.client |
| Modifier and Type | Class and Description |
|---|---|
class |
ContainerNotFoundException |
class |
DockerRequestException |
class |
DockerTimeoutException |
class |
ExecNotFoundException |
class |
ImageNotFoundException |
class |
ImagePullFailedException |
class |
ImagePushFailedException |
| Modifier and Type | Method and Description |
|---|---|
LogStream |
DockerClient.attachContainer(String containerId,
DockerClient.AttachParameter... params)
Attach to the container id
|
LogStream |
DefaultDockerClient.attachContainer(String containerId,
DockerClient.AttachParameter... params) |
int |
DockerClient.auth(AuthConfig authConfig)
Check auth configuration.
|
int |
DefaultDockerClient.auth(AuthConfig authConfig) |
private String |
DefaultDockerClient.authHeader() |
private String |
DefaultDockerClient.authHeader(AuthConfig authConfig) |
private String |
DefaultDockerClient.authRegistryHeader(AuthRegistryConfig authRegistryConfig) |
String |
DockerClient.build(Path directory,
DockerClient.BuildParameter... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
DockerClient.BuildParameter... params) |
String |
DockerClient.build(Path directory,
ProgressHandler handler,
DockerClient.BuildParameter... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
ProgressHandler handler,
DockerClient.BuildParameter... params) |
String |
DockerClient.build(Path directory,
String name,
DockerClient.BuildParameter... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
DockerClient.BuildParameter... params) |
String |
DockerClient.build(Path directory,
String name,
ProgressHandler handler,
DockerClient.BuildParameter... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
ProgressHandler handler,
DockerClient.BuildParameter... params) |
String |
DockerClient.build(Path directory,
String name,
String dockerfile,
ProgressHandler handler,
DockerClient.BuildParameter... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
String dockerfile,
ProgressHandler handler,
DockerClient.BuildParameter... params) |
ContainerCreation |
DockerClient.commitContainer(String containerId,
String repo,
String tag,
ContainerConfig config,
String comment,
String author)
Create a new image from a container's changes.
|
ContainerCreation |
DefaultDockerClient.commitContainer(String containerId,
String repo,
String tag,
ContainerConfig config,
String comment,
String author) |
InputStream |
DockerClient.copyContainer(String containerId,
String path)
Copies some files out of a container.
|
InputStream |
DefaultDockerClient.copyContainer(String containerId,
String path) |
ContainerCreation |
DockerClient.createContainer(ContainerConfig config)
Create a docker container.
|
ContainerCreation |
DefaultDockerClient.createContainer(ContainerConfig config) |
ContainerCreation |
DockerClient.createContainer(ContainerConfig config,
String name)
Create a docker container.
|
ContainerCreation |
DefaultDockerClient.createContainer(ContainerConfig config,
String name) |
String |
DockerClient.execCreate(String containerId,
String[] cmd,
DockerClient.ExecParameter... params)
Sets up an exec instance in a running container id.
|
String |
DefaultDockerClient.execCreate(String containerId,
String[] cmd,
DockerClient.ExecParameter... params) |
ExecState |
DockerClient.execInspect(String execId)
Inspects a running or previously run exec instance id.
|
ExecState |
DefaultDockerClient.execInspect(String execId) |
LogStream |
DockerClient.execStart(String execId,
DockerClient.ExecStartParameter... params)
Starts a previously set up exec instance id.
|
LogStream |
DefaultDockerClient.execStart(String execId,
DockerClient.ExecStartParameter... params) |
InputStream |
DockerClient.exportContainer(String containerId)
Export a docker container as a tar archive.
|
InputStream |
DefaultDockerClient.exportContainer(String containerId) |
boolean |
ProgressStream.hasNextMessage(String method,
URI uri) |
Info |
DockerClient.info()
Get docker instance information.
|
Info |
DefaultDockerClient.info() |
ContainerInfo |
DockerClient.inspectContainer(String containerId)
Inspect a docker container.
|
ContainerInfo |
DefaultDockerClient.inspectContainer(String containerId) |
ImageInfo |
DockerClient.inspectImage(String image)
Inspect a docker container image.
|
ImageInfo |
DefaultDockerClient.inspectImage(String image) |
void |
DockerClient.killContainer(String containerId)
Kill a docker container.
|
void |
DefaultDockerClient.killContainer(String containerId) |
List<Container> |
DockerClient.listContainers(DockerClient.ListContainersParam... params)
List docker containers.
|
List<Container> |
DefaultDockerClient.listContainers(DockerClient.ListContainersParam... params) |
List<Image> |
DockerClient.listImages(DockerClient.ListImagesParam... params)
List docker images.
|
List<Image> |
DefaultDockerClient.listImages(DockerClient.ListImagesParam... params) |
LogStream |
DockerClient.logs(String containerId,
DockerClient.LogsParameter... params)
Get docker container logs.
|
LogStream |
DefaultDockerClient.logs(String containerId,
DockerClient.LogsParameter... params) |
ProgressMessage |
ProgressStream.nextMessage(String method,
URI uri) |
void |
DockerClient.pauseContainer(String containerId)
Pause a docker container.
|
void |
DefaultDockerClient.pauseContainer(String containerId) |
String |
DockerClient.ping()
Ping the docker daemon.
|
String |
DefaultDockerClient.ping() |
void |
LoggingBuildHandler.progress(ProgressMessage message) |
void |
AnsiProgressHandler.progress(ProgressMessage message) |
void |
LoggingPullHandler.progress(ProgressMessage message) |
void |
ProgressHandler.progress(ProgressMessage message)
This method will be called for each progress message received from Docker.
|
void |
LoggingPushHandler.progress(ProgressMessage message) |
private RuntimeException |
DefaultDockerClient.propagate(String method,
javax.ws.rs.client.WebTarget resource,
Exception e) |
void |
DockerClient.pull(String image)
Pull a docker container image.
|
void |
DefaultDockerClient.pull(String image) |
void |
DockerClient.pull(String image,
AuthConfig authConfig)
Pull a private docker container image.
|
void |
DefaultDockerClient.pull(String image,
AuthConfig authConfig) |
void |
DockerClient.pull(String image,
AuthConfig authConfig,
ProgressHandler handler)
Pull a private docker container image, using a custom ProgressMessageHandler.
|
void |
DefaultDockerClient.pull(String image,
AuthConfig authConfig,
ProgressHandler handler) |
void |
DockerClient.pull(String image,
ProgressHandler handler)
Pull a docker container image, using a custom ProgressMessageHandler
|
void |
DefaultDockerClient.pull(String image,
ProgressHandler handler) |
void |
DockerClient.push(String image)
Push a docker container image.
|
void |
DefaultDockerClient.push(String image) |
void |
DockerClient.push(String image,
ProgressHandler handler)
Push a docker container image, using a custom ProgressHandler
|
void |
DefaultDockerClient.push(String image,
ProgressHandler handler) |
void |
DockerClient.removeContainer(String containerId)
Remove a docker container.
|
void |
DefaultDockerClient.removeContainer(String containerId) |
void |
DockerClient.removeContainer(String containerId,
boolean removeVolumes)
Remove a docker container.
|
void |
DefaultDockerClient.removeContainer(String containerId,
boolean removeVolumes) |
List<RemovedImage> |
DockerClient.removeImage(String image)
Remove a docker image.
|
List<RemovedImage> |
DefaultDockerClient.removeImage(String image) |
List<RemovedImage> |
DockerClient.removeImage(String image,
boolean force,
boolean noPrune)
Remove a docker image.
|
List<RemovedImage> |
DefaultDockerClient.removeImage(String image,
boolean force,
boolean noPrune) |
private <T> T |
DefaultDockerClient.request(String method,
Class<T> clazz,
javax.ws.rs.client.WebTarget resource,
javax.ws.rs.client.Invocation.Builder request) |
private <T> T |
DefaultDockerClient.request(String method,
Class<T> clazz,
javax.ws.rs.client.WebTarget resource,
javax.ws.rs.client.Invocation.Builder request,
javax.ws.rs.client.Entity<?> entity) |
private <T> T |
DefaultDockerClient.request(String method,
javax.ws.rs.core.GenericType<T> type,
javax.ws.rs.client.WebTarget resource,
javax.ws.rs.client.Invocation.Builder request) |
private void |
DefaultDockerClient.request(String method,
javax.ws.rs.client.WebTarget resource,
javax.ws.rs.client.Invocation.Builder request) |
void |
DockerClient.restartContainer(String containerId)
Restart a docker container.
|
void |
DefaultDockerClient.restartContainer(String containerId) |
void |
DockerClient.restartContainer(String containerId,
int secondsToWaitBeforeRestart)
Restart a docker container.
|
void |
DefaultDockerClient.restartContainer(String containerId,
int secondsToWaitBeforeRestart) |
List<ImageSearchResult> |
DockerClient.searchImages(String term)
Search for images on Docker Hub
|
List<ImageSearchResult> |
DefaultDockerClient.searchImages(String term) |
void |
DockerClient.startContainer(String containerId)
Start a docker container.
|
void |
DefaultDockerClient.startContainer(String containerId) |
ContainerStats |
DockerClient.stats(String containerId)
Retrieves one-time stats (stream=0) for the container with the specified id.
|
ContainerStats |
DefaultDockerClient.stats(String containerId) |
void |
DockerClient.stopContainer(String containerId,
int secondsToWaitBeforeKilling)
Stop a docker container by sending a SIGTERM, and following up with a SIGKILL if the
container doesn't exit gracefully and in a timely manner.
|
void |
DefaultDockerClient.stopContainer(String containerId,
int secondsToWaitBeforeKilling) |
void |
DockerClient.tag(String image,
String name)
Tag a docker image.
|
void |
DefaultDockerClient.tag(String image,
String name) |
void |
DockerClient.tag(String image,
String name,
boolean force)
Tag a docker image.
|
void |
DefaultDockerClient.tag(String image,
String name,
boolean force) |
void |
ProgressStream.tail(ProgressHandler handler,
String method,
URI uri) |
void |
DockerClient.unpauseContainer(String containerId)
Unpause a docker container.
|
void |
DefaultDockerClient.unpauseContainer(String containerId) |
Version |
DockerClient.version()
Get the docker version.
|
Version |
DefaultDockerClient.version() |
ContainerExit |
DockerClient.waitContainer(String containerId)
Wait for a docker container to exit.
|
ContainerExit |
DefaultDockerClient.waitContainer(String containerId) |
Copyright © 2015. All rights reserved.