| Package | Description |
|---|---|
| com.spotify.docker.client | |
| com.spotify.docker.client.exceptions |
| Modifier and Type | Method and Description |
|---|---|
InputStream |
DockerClient.archiveContainer(String containerId,
String path)
Copies an archive out of a container.
|
InputStream |
DefaultDockerClient.archiveContainer(String containerId,
String path) |
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) |
String |
DockerClient.build(Path directory,
DockerClient.BuildParam... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
DockerClient.BuildParam... params) |
String |
DockerClient.build(Path directory,
ProgressHandler handler,
DockerClient.BuildParam... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
ProgressHandler handler,
DockerClient.BuildParam... params) |
String |
DockerClient.build(Path directory,
String name,
DockerClient.BuildParam... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
DockerClient.BuildParam... params) |
String |
DockerClient.build(Path directory,
String name,
ProgressHandler handler,
DockerClient.BuildParam... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
ProgressHandler handler,
DockerClient.BuildParam... params) |
String |
DockerClient.build(Path directory,
String name,
String dockerfile,
ProgressHandler handler,
DockerClient.BuildParam... params)
Build a docker image.
|
String |
DefaultDockerClient.build(Path directory,
String name,
String dockerfile,
ProgressHandler handler,
DockerClient.BuildParam... 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) |
void |
DockerClient.connectToNetwork(String containerId,
String networkId)
Connects a docker container to a network.
|
void |
DefaultDockerClient.connectToNetwork(String containerId,
String networkId) |
InputStream |
DockerClient.copyContainer(String containerId,
String path)
Deprecated.
Replaced by
DockerClient.archiveContainer(String, String) in API 1.20, removed in 1.24. |
InputStream |
DefaultDockerClient.copyContainer(String containerId,
String path)
Deprecated.
|
void |
DockerClient.copyToContainer(Path directory,
String containerId,
String path)
Copies some files from host to container.
|
void |
DefaultDockerClient.copyToContainer(Path directory,
String containerId,
String path) |
void |
DockerClient.create(String image,
InputStream imagePayload)
Creates a single image from a tarball.
|
void |
DefaultDockerClient.create(String image,
InputStream imagePayload) |
void |
DockerClient.create(String image,
InputStream imagePayload,
ProgressHandler handler)
Creates a single image from a tarball.
|
void |
DefaultDockerClient.create(String image,
InputStream imagePayload,
ProgressHandler handler) |
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) |
NetworkCreation |
DockerClient.createNetwork(NetworkConfig networkConfig)
Create a new network
|
NetworkCreation |
DefaultDockerClient.createNetwork(NetworkConfig networkConfig) |
ServiceCreateResponse |
DockerClient.createService(ServiceSpec spec)
Create a new service.
|
ServiceCreateResponse |
DefaultDockerClient.createService(ServiceSpec spec) |
ServiceCreateResponse |
DockerClient.createService(ServiceSpec spec,
AuthConfig authConfig)
Create a new service.
|
ServiceCreateResponse |
DefaultDockerClient.createService(ServiceSpec spec,
AuthConfig config) |
Volume |
DockerClient.createVolume() |
Volume |
DefaultDockerClient.createVolume() |
Volume |
DockerClient.createVolume(Volume volume) |
Volume |
DefaultDockerClient.createVolume(Volume volume) |
void |
DockerClient.disconnectFromNetwork(String containerId,
String networkId)
Disconnects a docker container to a network.
|
void |
DefaultDockerClient.disconnectFromNetwork(String containerId,
String networkId) |
EventStream |
DockerClient.events(DockerClient.EventsParam... params)
Watches the docker API for events.
|
EventStream |
DefaultDockerClient.events(DockerClient.EventsParam... params) |
ExecCreation |
DockerClient.execCreate(String containerId,
String[] cmd,
DockerClient.ExecCreateParam... params)
Sets up an exec instance in a running container id.
|
ExecCreation |
DefaultDockerClient.execCreate(String containerId,
String[] cmd,
DockerClient.ExecCreateParam... params) |
ExecState |
DockerClient.execInspect(String execId)
Inspects a running or previously run exec instance id.
|
ExecState |
DefaultDockerClient.execInspect(String execId) |
void |
DockerClient.execResizeTty(String execId,
Integer height,
Integer width)
Resizes the tty session used by an exec command.
|
void |
DefaultDockerClient.execResizeTty(String execId,
Integer height,
Integer width) |
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) |
List<ImageHistory> |
DockerClient.history(String image)
Return the history of the image.
|
List<ImageHistory> |
DefaultDockerClient.history(String image) |
Info |
DockerClient.info()
Get docker instance information.
|
Info |
DefaultDockerClient.info() |
ContainerInfo |
DockerClient.inspectContainer(String containerId)
Inspect a docker container.
|
ContainerInfo |
DefaultDockerClient.inspectContainer(String containerId) |
List<ContainerChange> |
DockerClient.inspectContainerChanges(String containerId)
Inspect changes on a container's filesystem.
|
List<ContainerChange> |
DefaultDockerClient.inspectContainerChanges(String containerId) |
ImageInfo |
DockerClient.inspectImage(String image)
Inspect a docker container image.
|
ImageInfo |
DefaultDockerClient.inspectImage(String image) |
Network |
DockerClient.inspectNetwork(String networkId)
Inspect a specific network
|
Network |
DefaultDockerClient.inspectNetwork(String networkId) |
Service |
DockerClient.inspectService(String serviceId)
Inspect an existing service.
|
Service |
DefaultDockerClient.inspectService(String serviceId) |
Swarm |
DockerClient.inspectSwarm()
Inspect the Swarm cluster.
|
Swarm |
DefaultDockerClient.inspectSwarm() |
Task |
DockerClient.inspectTask(String taskId)
Inspect an existing task.
|
Task |
DefaultDockerClient.inspectTask(String taskId) |
Volume |
DockerClient.inspectVolume(String volumeName) |
Volume |
DefaultDockerClient.inspectVolume(String volumeName) |
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) |
List<Network> |
DockerClient.listNetworks()
List all networks
|
List<Network> |
DefaultDockerClient.listNetworks() |
List<Service> |
DockerClient.listServices()
List all services.
|
List<Service> |
DefaultDockerClient.listServices() |
List<Service> |
DockerClient.listServices(Service.Criteria criteria)
List services that match the given criteria.
|
List<Service> |
DefaultDockerClient.listServices(Service.Criteria criteria) |
List<Task> |
DockerClient.listTasks()
List all tasks.
|
List<Task> |
DefaultDockerClient.listTasks() |
List<Task> |
DockerClient.listTasks(Task.Criteria criteria)
List tasks that match the given criteria.
|
List<Task> |
DefaultDockerClient.listTasks(Task.Criteria criteria) |
VolumeList |
DockerClient.listVolumes(DockerClient.ListVolumesParam... params) |
VolumeList |
DefaultDockerClient.listVolumes(DockerClient.ListVolumesParam... params) |
void |
DockerClient.load(InputStream imagePayload)
Load a set of images and tags from a tarball.
|
void |
DefaultDockerClient.load(InputStream imagePayload) |
void |
DockerClient.load(String image,
InputStream imagePayload)
Deprecated.
Use
DockerClient.load(InputStream) to load a set of image layers from a tarball. Use
DockerClient.create(String, InputStream) to create a single image from the contents of a tarball. |
void |
DefaultDockerClient.load(String image,
InputStream imagePayload)
Deprecated.
|
void |
DockerClient.load(String image,
InputStream imagePayload,
AuthConfig authConfig)
Deprecated.
Use
DockerClient.load(InputStream) to load a set of image layers from a tarball. Use
DockerClient.create(String, InputStream) to create a single image from the contents of a tarball. |
void |
DefaultDockerClient.load(String image,
InputStream imagePayload,
AuthConfig authConfig)
Deprecated.
|
void |
DockerClient.load(String image,
InputStream imagePayload,
AuthConfig authConfig,
ProgressHandler handler)
Deprecated.
Use
DockerClient.load(InputStream) to load a set of image layers from a tarball. Use
DockerClient.create(String, InputStream, ProgressHandler) to create a single image from the
contents of a tarball. |
void |
DefaultDockerClient.load(String image,
InputStream imagePayload,
AuthConfig authConfig,
ProgressHandler handler)
Deprecated.
|
void |
DockerClient.load(String image,
InputStream imagePayload,
ProgressHandler handler)
Deprecated.
Use
DockerClient.load(InputStream) to load a set of image layers from a tarball. Use
DockerClient.create(String, InputStream, ProgressHandler) to create a single image from the
contents of a tarball. |
void |
DefaultDockerClient.load(String image,
InputStream imagePayload,
ProgressHandler handler)
Deprecated.
|
LogStream |
DockerClient.logs(String containerId,
DockerClient.LogsParam... params)
Get docker container logs.
|
LogStream |
DefaultDockerClient.logs(String containerId,
DockerClient.LogsParam... params) |
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 |
ProgressHandler.progress(ProgressMessage message)
This method will be called for each progress message received from Docker.
|
void |
LoggingPushHandler.progress(ProgressMessage message) |
void |
LoggingPullHandler.progress(ProgressMessage message) |
void |
LoggingBuildHandler.progress(ProgressMessage message) |
void |
AnsiProgressHandler.progress(ProgressMessage message) |
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,
AuthConfig authconfig) |
void |
DefaultDockerClient.push(String image,
AuthConfig authconfig) |
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.push(String image,
ProgressHandler handler,
AuthConfig authConfig) |
void |
DefaultDockerClient.push(String image,
ProgressHandler handler,
AuthConfig authConfig) |
void |
DockerClient.removeContainer(String containerId)
Remove a docker container.
|
void |
DefaultDockerClient.removeContainer(String containerId) |
void |
DockerClient.removeContainer(String containerId,
boolean removeVolumes)
Deprecated.
|
void |
DefaultDockerClient.removeContainer(String containerId,
boolean removeVolumes)
Deprecated.
|
void |
DockerClient.removeContainer(String containerId,
DockerClient.RemoveContainerParam... params)
Remove a docker container.
|
void |
DefaultDockerClient.removeContainer(String containerId,
DockerClient.RemoveContainerParam... params) |
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) |
void |
DockerClient.removeNetwork(String networkId)
Remove a docker network.
|
void |
DefaultDockerClient.removeNetwork(String networkId) |
void |
DockerClient.removeService(String serviceId)
Remove an existing service.
|
void |
DefaultDockerClient.removeService(String serviceId) |
void |
DockerClient.removeVolume(String volumeName) |
void |
DefaultDockerClient.removeVolume(String volumeName) |
void |
DockerClient.removeVolume(Volume volume) |
void |
DefaultDockerClient.removeVolume(Volume volume) |
void |
DockerClient.renameContainer(String containerId,
String name)
Rename a docker container.
|
void |
DefaultDockerClient.renameContainer(String containerId,
String name) |
void |
DockerClient.resizeTty(String containerId,
Integer height,
Integer width)
Resize container TTY
This API is valid only if
tty was specified as
part of creating the container. |
void |
DefaultDockerClient.resizeTty(String containerId,
Integer height,
Integer width) |
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) |
InputStream |
DockerClient.save(String... images)
Get a tarball containing all images and metadata for the repository specified.
|
InputStream |
DefaultDockerClient.save(String... images) |
InputStream |
DockerClient.save(String image,
AuthConfig authConfig)
Deprecated.
AuthConfig is not required. Use
DockerClient.save(String...). |
InputStream |
DefaultDockerClient.save(String image,
AuthConfig authConfig)
Deprecated.
|
InputStream |
DockerClient.saveMultiple(String... images)
Get a tarball containing all images and metadata for one or more repositories.
|
InputStream |
DefaultDockerClient.saveMultiple(String... images) |
List<ImageSearchResult> |
DockerClient.searchImages(String term)
Search for images on Docker Hub
This method is broken for Docker 1.7.x because of a Docker bug.
|
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) |
TopResults |
DockerClient.topContainer(String containerId)
List processes running inside the container by using
ps. |
TopResults |
DefaultDockerClient.topContainer(String containerId) |
TopResults |
DockerClient.topContainer(String containerId,
String psArgs)
List processes running inside the container using
ps and the given arguments. |
TopResults |
DefaultDockerClient.topContainer(String containerId,
String psArgs) |
void |
DockerClient.unpauseContainer(String containerId)
Unpause a docker container.
|
void |
DefaultDockerClient.unpauseContainer(String containerId) |
void |
DockerClient.updateService(String serviceId,
Long version,
ServiceSpec spec)
Update an existing service.
|
void |
DefaultDockerClient.updateService(String serviceId,
Long version,
ServiceSpec spec) |
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) |
| Modifier and Type | Class and Description |
|---|---|
class |
BadParamException |
class |
ConflictException |
class |
ContainerNotFoundException |
class |
ContainerRenameConflictException |
class |
DockerRequestException |
class |
DockerTimeoutException |
class |
ExecCreateConflictException |
class |
ExecNotFoundException |
class |
ExecStartConflictException |
class |
ImageNotFoundException |
class |
ImagePullFailedException |
class |
ImagePushFailedException |
class |
NetworkNotFoundException |
class |
NotFoundException |
class |
PermissionException |
class |
ServiceNotFoundException |
class |
TaskNotFoundException |
class |
UnsupportedApiVersionException |
class |
VolumeNotFoundException |
Copyright © 2016. All rights reserved.