DefaultDockerClient (docker-client 6.2.4 API)

java.lang.Object
- com.spotify.docker.client.DefaultDockerClient

All Implemented Interfaces:: DockerClient, Closeable, AutoCloseable

public class DefaultDockerClient
extends Object
implements DockerClient, Closeable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultDockerClient.Builder
- Nested classes/interfaces inherited from interface com.spotify.docker.client.DockerClient
  DockerClient.AttachParameter, DockerClient.BuildParam, DockerClient.EventsFilterParam, DockerClient.EventsParam, DockerClient.ExecCreateParam, DockerClient.ExecStartParameter, DockerClient.ListContainersFilterParam, DockerClient.ListContainersParam, DockerClient.ListImagesFilterParam, DockerClient.ListImagesParam, DockerClient.ListVolumesFilterParam, DockerClient.ListVolumesParam, DockerClient.LogsParam, DockerClient.RemoveContainerParam

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultDockerClient.Builder`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DefaultDockerClient(DefaultDockerClient.Builder builder)` Create a new client using the configuration of the builder.
	`DefaultDockerClient(String uri)` Create a new client with default configuration.
	`DefaultDockerClient(URI uri)` Create a new client with default configuration.
	`DefaultDockerClient(URI uri, DockerCertificates dockerCertificates)` Create a new client with default configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`InputStream`	`archiveContainer(String containerId, String path)` Copies an archive out of a container.
`LogStream`	`attachContainer(String containerId, DockerClient.AttachParameter... params)` Attach to the container id.
`int`	`auth(AuthConfig authConfig)` Check auth configuration.
`String`	`build(Path directory, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`String`	`build(Path directory, String name, String dockerfile, ProgressHandler handler, DockerClient.BuildParam... params)` Build a docker image.
`static DefaultDockerClient.Builder`	`builder()` Create a new `DefaultDockerClient` builder.
`void`	`close()` Closes any and all underlying connections to docker, and release resources.
`ContainerCreation`	`commitContainer(String containerId, String repo, String tag, ContainerConfig config, String comment, String author)` Create a new image from a container's changes.
`void`	`connectToNetwork(String containerId, String networkId)` Connects a docker container to a network.
`InputStream`	`copyContainer(String containerId, String path)` Deprecated.
`void`	`copyToContainer(Path directory, String containerId, String path)` Copies some files from host to container.
`void`	`create(String image, InputStream imagePayload)` Creates a single image from a tarball.
`void`	`create(String image, InputStream imagePayload, ProgressHandler handler)` Creates a single image from a tarball.
`ContainerCreation`	`createContainer(ContainerConfig config)` Create a docker container.
`ContainerCreation`	`createContainer(ContainerConfig config, String name)` Create a docker container.
`NetworkCreation`	`createNetwork(NetworkConfig networkConfig)` Create a new network.
`ServiceCreateResponse`	`createService(ServiceSpec spec)` Create a new service.
`ServiceCreateResponse`	`createService(ServiceSpec spec, AuthConfig config)` Create a new service.
`Volume`	`createVolume()`
`Volume`	`createVolume(Volume volume)`
`void`	`disconnectFromNetwork(String containerId, String networkId)` Disconnects a docker container to a network.
`EventStream`	`events(DockerClient.EventsParam... params)` Watches the docker API for events.
`ExecCreation`	`execCreate(String containerId, String[] cmd, DockerClient.ExecCreateParam... params)` Sets up an exec instance in a running container id.
`ExecState`	`execInspect(String execId)` Inspects a running or previously run exec instance id.
`void`	`execResizeTty(String execId, Integer height, Integer width)` Resizes the tty session used by an exec command.
`LogStream`	`execStart(String execId, DockerClient.ExecStartParameter... params)` Starts a previously set up exec instance id.
`InputStream`	`exportContainer(String containerId)` Export a docker container as a tar archive.
`static DefaultDockerClient.Builder`	`fromEnv()` Create a new `DefaultDockerClient` builder prepopulated with values loaded from the DOCKER_HOST and DOCKER_CERT_PATH environment variables.
`String`	`getHost()` Get the Docker host address.
`List<ImageHistory>`	`history(String image)` Return the history of the image.
`Info`	`info()` Get docker instance information.
`ContainerInfo`	`inspectContainer(String containerId)` Inspect a docker container.
`List<ContainerChange>`	`inspectContainerChanges(String containerId)` Inspect changes on a container's filesystem.
`ImageInfo`	`inspectImage(String image)` Inspect a docker container image.
`Network`	`inspectNetwork(String networkId)` Inspect a specific network.
`Service`	`inspectService(String serviceId)` Inspect an existing service.
`Swarm`	`inspectSwarm()` Inspect the Swarm cluster.
`Task`	`inspectTask(String taskId)` Inspect an existing task.
`Volume`	`inspectVolume(String volumeName)`
`void`	`killContainer(String containerId)` Kill a docker container.
`List<Container>`	`listContainers(DockerClient.ListContainersParam... params)` List docker containers.
`List<Image>`	`listImages(DockerClient.ListImagesParam... params)` List docker images.
`List<Network>`	`listNetworks()` List all networks.
`List<Service>`	`listServices()` List all services.
`List<Service>`	`listServices(Service.Criteria criteria)` List services that match the given criteria.
`List<Task>`	`listTasks()` List all tasks.
`List<Task>`	`listTasks(Task.Criteria criteria)` List tasks that match the given criteria.
`VolumeList`	`listVolumes(DockerClient.ListVolumesParam... params)`
`void`	`load(InputStream imagePayload)` Load a set of images and tags from a tarball.
`void`	`load(String image, InputStream imagePayload)` Deprecated.
`void`	`load(String image, InputStream imagePayload, AuthConfig authConfig)` Deprecated.
`void`	`load(String image, InputStream imagePayload, AuthConfig authConfig, ProgressHandler handler)` Deprecated.
`void`	`load(String image, InputStream imagePayload, ProgressHandler handler)` Deprecated.
`LogStream`	`logs(String containerId, DockerClient.LogsParam... params)` Get docker container logs.
`void`	`pauseContainer(String containerId)` Pause a docker container.
`String`	`ping()` Ping the docker daemon.
`void`	`pull(String image)` Pull a docker container image.
`void`	`pull(String image, AuthConfig authConfig)` Pull a private docker container image.
`void`	`pull(String image, AuthConfig authConfig, ProgressHandler handler)` Pull a private docker container image, using a custom ProgressMessageHandler.
`void`	`pull(String image, ProgressHandler handler)` Pull a docker container image, using a custom ProgressMessageHandler
`void`	`push(String image)` Push a docker container image.
`void`	`push(String image, AuthConfig authconfig)`
`void`	`push(String image, ProgressHandler handler)` Push a docker container image, using a custom ProgressHandler
`void`	`push(String image, ProgressHandler handler, AuthConfig authConfig)`
`void`	`removeContainer(String containerId)` Remove a docker container.
`void`	`removeContainer(String containerId, boolean removeVolumes)` Deprecated.
`void`	`removeContainer(String containerId, DockerClient.RemoveContainerParam... params)` Remove a docker container.
`List<RemovedImage>`	`removeImage(String image)` Remove a docker image.
`List<RemovedImage>`	`removeImage(String image, boolean force, boolean noPrune)` Remove a docker image.
`void`	`removeNetwork(String networkId)` Remove a docker network.
`void`	`removeService(String serviceId)` Remove an existing service.
`void`	`removeVolume(String volumeName)`
`void`	`removeVolume(Volume volume)`
`void`	`renameContainer(String containerId, String name)` Rename a docker container.
`void`	`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`	`restartContainer(String containerId)` Restart a docker container.
`void`	`restartContainer(String containerId, int secondsToWaitBeforeRestart)` Restart a docker container.
`InputStream`	`save(String... images)` Get a tarball containing all images and metadata for the repository specified.
`InputStream`	`save(String image, AuthConfig authConfig)` Deprecated.
`InputStream`	`saveMultiple(String... images)` Get a tarball containing all images and metadata for one or more repositories.
`List<ImageSearchResult>`	`searchImages(String term)` Search for images on Docker Hub
`void`	`startContainer(String containerId)` Start a docker container.
`ContainerStats`	`stats(String containerId)` Retrieves one-time stats (stream=0) for the container with the specified id.
`void`	`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`	`tag(String image, String name)` Tag a docker image.
`void`	`tag(String image, String name, boolean force)` Tag a docker image.
`TopResults`	`topContainer(String containerId)` List processes running inside the container by using `ps`.
`TopResults`	`topContainer(String containerId, String psArgs)` List processes running inside the container using `ps` and the given arguments.
`void`	`unpauseContainer(String containerId)` Unpause a docker container.
`void`	`updateService(String serviceId, Long version, ServiceSpec spec)` Update an existing service.
`Version`	`version()` Get the docker version.
`ContainerExit`	`waitContainer(String containerId)` Wait for a docker container to exit.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultDockerClient
```
public DefaultDockerClient(String uri)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
  - DefaultDockerClient
```
public DefaultDockerClient(URI uri)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
  - DefaultDockerClient
```
public DefaultDockerClient(URI uri,
                           DockerCertificates dockerCertificates)
```
    Create a new client with default configuration.
    
    Parameters:
    
    uri - The docker rest api uri.
    
    dockerCertificates - The certificates to use for HTTPS.
  - DefaultDockerClient
```
protected DefaultDockerClient(DefaultDockerClient.Builder builder)
```
    Create a new client using the configuration of the builder.
    
    Parameters:
    
    builder - DefaultDockerClient builder
- Method Detail
  - getHost
```
public String getHost()
```
    Description copied from interface: DockerClient
    
    Get the Docker host address.
    
    Specified by:
    
    getHost in interface DockerClient
    
    Returns:
    
    the docker host name or IP
  - close
```
public void close()
```
    Description copied from interface: DockerClient
    
    Closes any and all underlying connections to docker, and release resources.
    
    Specified by:
    
    close in interface DockerClient
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - ping
```
public String ping()
            throws DockerException,
                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Ping the docker daemon. Returns "OK" if all is well, though that it simply returns a 200 status is probably sufficient information.
    
    Specified by:
    
    ping in interface DockerClient
    
    Returns:
    
    String "OK"
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - version
```
public Version version()
                throws DockerException,
                       InterruptedException
```
    Description copied from interface: DockerClient
    
    Get the docker version.
    
    Specified by:
    
    version in interface DockerClient
    
    Returns:
    
    docker version
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - auth
```
public int auth(AuthConfig authConfig)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Check auth configuration.
    
    Specified by:
    
    auth in interface DockerClient
    
    Parameters:
    
    authConfig - The authentication config needed to pull the image.
    
    Returns:
    
    status code of auth request
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - info
```
public Info info()
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Get docker instance information.
    
    Specified by:
    
    info in interface DockerClient
    
    Returns:
    
    docker info
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listContainers
```
public List<Container> listContainers(DockerClient.ListContainersParam... params)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    List docker containers.
    
    Specified by:
    
    listContainers in interface DockerClient
    
    Parameters:
    
    params - Container listing and filtering options.
    
    Returns:
    
    A list of containers.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listImages
```
public List<Image> listImages(DockerClient.ListImagesParam... params)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    List docker images.
    
    Specified by:
    
    listImages in interface DockerClient
    
    Parameters:
    
    params - Image listing and filtering options.
    
    Returns:
    
    A list of images.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createContainer
```
public ContainerCreation createContainer(ContainerConfig config)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a docker container.
    
    Specified by:
    
    createContainer in interface DockerClient
    
    Parameters:
    
    config - The container configuration.
    
    Returns:
    
    Container creation result with container id and eventual warnings from docker.
    
    Throws:
    
    ImageNotFoundException - if the requested parent image was not found (404)
    
    DockerException - if logs cannot be attached, because container is not running (406), or if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createContainer
```
public ContainerCreation createContainer(ContainerConfig config,
                                         String name)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a docker container.
    
    Specified by:
    
    createContainer in interface DockerClient
    
    Parameters:
    
    config - The container configuration.
    
    name - The container name.
    
    Returns:
    
    Container creation result with container id and eventual warnings from docker.
    
    Throws:
    
    ImageNotFoundException - if the requested parent image was not found (404)
    
    DockerException - if logs cannot be attached, because container is not running (406), or if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - startContainer
```
public void startContainer(String containerId)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Start a docker container.
    
    Specified by:
    
    startContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to start.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pauseContainer
```
public void pauseContainer(String containerId)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Pause a docker container.
    
    Specified by:
    
    pauseContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to pause.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - unpauseContainer
```
public void unpauseContainer(String containerId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Unpause a docker container.
    
    Specified by:
    
    unpauseContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to pause.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - restartContainer
```
public void restartContainer(String containerId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Restart a docker container. with a 10 second default wait
    
    Specified by:
    
    restartContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to restart.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - restartContainer
```
public void restartContainer(String containerId,
                             int secondsToWaitBeforeRestart)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Restart a docker container.
    
    Specified by:
    
    restartContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to restart.
    
    secondsToWaitBeforeRestart - number of seconds to wait before killing the container.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - killContainer
```
public void killContainer(String containerId)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Kill a docker container. Note: This implementation deviates from the Docker Remote API. The latter accepts the kill signal as an argument. This implementation does not accept the signal argument; instead, the default SIGKILL is sent.
    
    Specified by:
    
    killContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to kill.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - stopContainer
```
public void stopContainer(String containerId,
                          int secondsToWaitBeforeKilling)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    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.
    
    Specified by:
    
    stopContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to stop.
    
    secondsToWaitBeforeKilling - Time to wait after SIGTERM before sending SIGKILL.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - waitContainer
```
public ContainerExit waitContainer(String containerId)
                            throws DockerException,
                                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Wait for a docker container to exit.
    
    Specified by:
    
    waitContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to wait for.
    
    Returns:
    
    Exit response with status code.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
public void removeContainer(String containerId)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
@Deprecated
public void removeContainer(String containerId,
                                        boolean removeVolumes)
                                 throws DockerException,
                                        InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    removeVolumes - Whether to remove volumes as well.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeContainer
```
public void removeContainer(String containerId,
                            DockerClient.RemoveContainerParam... params)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker container.
    
    Specified by:
    
    removeContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to remove.
    
    params - DockerClient.RemoveContainerParam
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - exportContainer
```
public InputStream exportContainer(String containerId)
                            throws DockerException,
                                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Export a docker container as a tar archive.
    
    Specified by:
    
    exportContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to export.
    
    Returns:
    
    A stream in tar format that contains the contents of the container file system.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - copyContainer
```
@Deprecated
public InputStream copyContainer(String containerId,
                                             String path)
                                      throws DockerException,
                                             InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Copies some files out of a container. (removed on API version 1.24)
    
    Specified by:
    
    copyContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to copy files from.
    
    path - The path inside of the container to copy. If this is a directory, it will be copied recursively. If this is a file, only that file will be copied.
    
    Returns:
    
    A stream in tar format that contains the copied files. If a directory was copied, the directory will be at the root of the tar archive (so copy(..., "/usr/share") will result in a directory called share in the tar archive). The directory name is completely resolved, so copying "/usr/share/././." will still create a directory called "share" in the tar archive. If a single file was copied, that file will be the sole entry in the tar archive. Copying "." or equivalently "/" will result in the tar archive containing a single folder named after the container ID.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    UnsupportedApiVersionException - If client API is greater than or equal to 1.24
    
    InterruptedException - If the thread is interrupted
  - archiveContainer
```
public InputStream archiveContainer(String containerId,
                                    String path)
                             throws DockerException,
                                    InterruptedException
```
    Description copied from interface: DockerClient
    
    Copies an archive out of a container. (API version 1.20+)
    
    Specified by:
    
    archiveContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to copy files from.
    
    path - The path inside of the container to copy. If this is a directory, it will be copied recursively. If this is a file, only that file will be copied.
    
    Returns:
    
    A stream in tar format that contains the copied files. If a directory was copied, the directory will be at the root of the tar archive (so copy(..., "/usr/share") will result in a directory called share in the tar archive). The directory name is completely resolved, so copying "/usr/share/././." will still create a directory called "share" in the tar archive. If a single file was copied, that file will be the sole entry in the tar archive. Copying "." or equivalently "/" will result in the tar archive containing a single folder named after the container ID.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - topContainer
```
public TopResults topContainer(String containerId)
                        throws DockerException,
                               InterruptedException
```
    Description copied from interface: DockerClient
    
    List processes running inside the container by using ps.
    
    Specified by:
    
    topContainer in interface DockerClient
    
    Parameters:
    
    containerId - the id of the container to examine
    
    Returns:
    
    the titles and process list for the container
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - topContainer
```
public TopResults topContainer(String containerId,
                               String psArgs)
                        throws DockerException,
                               InterruptedException
```
    Description copied from interface: DockerClient
    
    List processes running inside the container using ps and the given arguments.
    
    Specified by:
    
    topContainer in interface DockerClient
    
    Parameters:
    
    containerId - the id of the container to examine
    
    psArgs - the arguments to pass to ps inside the container, e.g., "-ef"
    
    Returns:
    
    the titles and process list for the container
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - copyToContainer
```
public void copyToContainer(Path directory,
                            String containerId,
                            String path)
                     throws DockerException,
                            InterruptedException,
                            IOException
```
    Description copied from interface: DockerClient
    
    Copies some files from host to container. (API version 1.20+)
    
    Specified by:
    
    copyToContainer in interface DockerClient
    
    Parameters:
    
    directory - The path to sent to container
    
    containerId - The id of the container to sent files.
    
    path - The path inside of the container to put files.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    PermissionException - if the volume or container root file system is marked "read only"
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If IOException
  - inspectContainerChanges
```
public List<ContainerChange> inspectContainerChanges(String containerId)
                                              throws DockerException,
                                                     InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect changes on a container's filesystem.
    
    Specified by:
    
    inspectContainerChanges in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container.
    
    Returns:
    
    A list of the changes to the container file system.
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectContainer
```
public ContainerInfo inspectContainer(String containerId)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a docker container.
    
    Specified by:
    
    inspectContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to inspect.
    
    Returns:
    
    Info about the container.
    
    Throws:
    
    ContainerNotFoundException - if container was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - commitContainer
```
public ContainerCreation commitContainer(String containerId,
                                         String repo,
                                         String tag,
                                         ContainerConfig config,
                                         String comment,
                                         String author)
                                  throws DockerException,
                                         InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new image from a container's changes.
    
    Specified by:
    
    commitContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to commit.
    
    repo - repository to commit to.
    
    tag - image tag.
    
    config - ContainerConfig to commit.
    
    comment - commit message.
    
    author - image author.
    
    Returns:
    
    ContainerCreation reply.
    
    Throws:
    
    ContainerNotFoundException - if container was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - renameContainer
```
public void renameContainer(String containerId,
                            String name)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Rename a docker container.
    
    Specified by:
    
    renameContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to rename.
    
    name - The new name the container will have
    
    Throws:
    
    ContainerNotFoundException - if container cannot be found (404)
    
    ContainerRenameConflictException - if name is already assigned (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - searchImages
```
public List<ImageSearchResult> searchImages(String term)
                                     throws DockerException,
                                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Search for images on Docker Hub
    This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/pull/14850.
    
    Specified by:
    
    searchImages in interface DockerClient
    
    Parameters:
    
    term - the search term
    
    Returns:
    
    a list of matches for the given search term
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - load
```
@Deprecated
public void load(String image,
                             InputStream imagePayload)
                      throws DockerException,
                             InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
@Deprecated
public void load(String image,
                             InputStream imagePayload,
                             AuthConfig authConfig)
                      throws DockerException,
                             InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    authConfig - The authentication config needed to pull the image.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
@Deprecated
public void load(String image,
                             InputStream imagePayload,
                             ProgressHandler handler)
                      throws DockerException,
                             InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
@Deprecated
public void load(String image,
                             InputStream imagePayload,
                             AuthConfig authConfig,
                             ProgressHandler handler)
                      throws DockerException,
                             InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    authConfig - The authentication config needed to pull the image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - load
```
public void load(InputStream imagePayload)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Load a set of images and tags from a tarball.
    
    Specified by:
    
    load in interface DockerClient
    
    Parameters:
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - create
```
public void create(String image,
                   InputStream imagePayload)
            throws DockerException,
                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    create in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - create
```
public void create(String image,
                   InputStream imagePayload,
                   ProgressHandler handler)
            throws DockerException,
                   InterruptedException
```
    Description copied from interface: DockerClient
    
    Creates a single image from a tarball. This method also tags the image with the given image name upon loading completion.
    
    Specified by:
    
    create in interface DockerClient
    
    Parameters:
    
    image - the name to assign to the image.
    
    imagePayload - the image's payload (i.e.: the stream corresponding to the image's .tar file).
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    InterruptedException - if the thread is interrupted.
  - save
```
public InputStream save(String... images)
                 throws DockerException,
                        IOException,
                        InterruptedException
```
    Description copied from interface: DockerClient
    
    Get a tarball containing all images and metadata for the repository specified.
    
    Specified by:
    
    save in interface DockerClient
    
    Parameters:
    
    images - the name(s) of one or more images to save. If a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned. If an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the 'repositories' file in the tarball, as there were no image names referenced.
    
    Returns:
    
    the images' .tar streams.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.
    
    InterruptedException - if the thread is interrupted.
  - save
```
@Deprecated
public InputStream save(String image,
                                    AuthConfig authConfig)
                             throws DockerException,
                                    IOException,
                                    InterruptedException
```
    Deprecated.
    
    Description copied from interface: DockerClient
    
    Get a tarball containing all images and metadata for the repository specified.
    
    Specified by:
    
    save in interface DockerClient
    
    Parameters:
    
    image - the name or id of the image to save. If a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned. If an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the 'repositories' file in the tarball, as there were no image names referenced.
    
    authConfig - The authentication config needed to pull the image.
    
    Returns:
    
    the image's .tar stream.
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.
    
    InterruptedException - if the thread is interrupted.
  - saveMultiple
```
public InputStream saveMultiple(String... images)
                         throws DockerException,
                                IOException,
                                InterruptedException
```
    Description copied from interface: DockerClient
    
    Get a tarball containing all images and metadata for one or more repositories.
    
    Specified by:
    
    saveMultiple in interface DockerClient
    
    Parameters:
    
    images - the name or id of the image to save. if it is a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID.
    
    Returns:
    
    a tar stream containing the image(s)
    
    Throws:
    
    DockerException - if a server error occurred (500).
    
    IOException - if the server started returning, but an I/O error occurred in the context of processing it on the client-side.
    
    InterruptedException - if the thread is interrupted.
  - pull
```
public void pull(String image)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a docker container image.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a docker container image, using a custom ProgressMessageHandler
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 AuthConfig authConfig)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a private docker container image.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    authConfig - The authentication config needed to pull the image.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - pull
```
public void pull(String image,
                 AuthConfig authConfig,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Pull a private docker container image, using a custom ProgressMessageHandler.
    
    Specified by:
    
    pull in interface DockerClient
    
    Parameters:
    
    image - The image to pull.
    
    authConfig - The authentication config needed to pull the image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - push
```
public void push(String image)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Push a docker container image.
    
    Specified by:
    
    push in interface DockerClient
    
    Parameters:
    
    image - The image to push.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - push
```
public void push(String image,
                 AuthConfig authconfig)
          throws DockerException,
                 InterruptedException
```
    Specified by:
    
    push in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - push
```
public void push(String image,
                 ProgressHandler handler)
          throws DockerException,
                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Push a docker container image, using a custom ProgressHandler
    
    Specified by:
    
    push in interface DockerClient
    
    Parameters:
    
    image - The image to push.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - push
```
public void push(String image,
                 ProgressHandler handler,
                 AuthConfig authConfig)
          throws DockerException,
                 InterruptedException
```
    Specified by:
    
    push in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - tag
```
public void tag(String image,
                String name)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Tag a docker image.
    
    Specified by:
    
    tag in interface DockerClient
    
    Parameters:
    
    image - The image to tag.
    
    name - The new name that will be applied to the image.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ImageNotFoundException - if image was not found (404)
    
    ConflictException - conflict (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - tag
```
public void tag(String image,
                String name,
                boolean force)
         throws DockerException,
                InterruptedException
```
    Description copied from interface: DockerClient
    
    Tag a docker image.
    
    Specified by:
    
    tag in interface DockerClient
    
    Parameters:
    
    image - The image to tag.
    
    name - The new name that will be applied to the image.
    
    force - Whether to force the tagging even if the tag is already assigned to another image.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ImageNotFoundException - if image was not found (404)
    
    ConflictException - conflict (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - build
```
public String build(Path directory,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - build
```
public String build(Path directory,
                    String name,
                    String dockerfile,
                    ProgressHandler handler,
                    DockerClient.BuildParam... params)
             throws DockerException,
                    InterruptedException,
                    IOException
```
    Description copied from interface: DockerClient
    
    Build a docker image.
    
    Specified by:
    
    build in interface DockerClient
    
    Parameters:
    
    directory - The directory containing the dockerfile.
    
    name - The repository name and optional tag to apply to the built image.
    
    dockerfile - The path within the build context to the Dockerfile
    
    handler - The handler to use for processing each progress message received from Docker.
    
    params - Additional flags to use during build.
    
    Returns:
    
    The id of the built image if successful, otherwise null.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
    
    IOException - If some IO shit happened.
  - inspectImage
```
public ImageInfo inspectImage(String image)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a docker container image.
    
    Specified by:
    
    inspectImage in interface DockerClient
    
    Parameters:
    
    image - The image to inspect.
    
    Returns:
    
    Info about the image.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeImage
```
public List<RemovedImage> removeImage(String image)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker image.
    
    Specified by:
    
    removeImage in interface DockerClient
    
    Parameters:
    
    image - The image to remove.
    
    Returns:
    
    A list describing each image which was removed.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    ConflictException - conflict (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeImage
```
public List<RemovedImage> removeImage(String image,
                                      boolean force,
                                      boolean noPrune)
                               throws DockerException,
                                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker image.
    
    Specified by:
    
    removeImage in interface DockerClient
    
    Parameters:
    
    image - The image to remove.
    
    force - Force image removal.
    
    noPrune - Do not delete untagged parents.
    
    Returns:
    
    A list describing each image which was removed.
    
    Throws:
    
    ImageNotFoundException - if image was not found (404)
    
    ConflictException - conflict (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - history
```
public List<ImageHistory> history(String image)
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    Return the history of the image.
    
    Specified by:
    
    history in interface DockerClient
    
    Parameters:
    
    image - An image name or ID.
    
    Returns:
    
    A List of ImageHistory
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - logs
```
public LogStream logs(String containerId,
                      DockerClient.LogsParam... params)
               throws DockerException,
                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Get docker container logs.
    
    Specified by:
    
    logs in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to get logs for.
    
    params - Params for controlling what streams to get and whether to tail or not.
    
    Returns:
    
    A log message stream.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - events
```
public EventStream events(DockerClient.EventsParam... params)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Watches the docker API for events.
    This method is broken for Docker 1.7.x because of a Docker bug. See https://github.com/docker/docker/issues/14354.
    
    Specified by:
    
    events in interface DockerClient
    
    Parameters:
    
    params - The parameters to apply to the events request
    
    Returns:
    
    An event stream
    
    Throws:
    
    DockerException - If a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - attachContainer
```
public LogStream attachContainer(String containerId,
                                 DockerClient.AttachParameter... params)
                          throws DockerException,
                                 InterruptedException
```
    Description copied from interface: DockerClient
    
    Attach to the container id.
    
    Specified by:
    
    attachContainer in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to get logs for.
    
    params - Params for controlling what streams to get and whether to tail or not.
    
    Returns:
    
    A log message stream.
    
    Throws:
    
    BadParamException - if one or more params were bad (400)
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execCreate
```
public ExecCreation execCreate(String containerId,
                               String[] cmd,
                               DockerClient.ExecCreateParam... params)
                        throws DockerException,
                               InterruptedException
```
    Description copied from interface: DockerClient
    
    Sets up an exec instance in a running container id.
    
    Specified by:
    
    execCreate in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container
    
    cmd - shell command
    
    params - Exec params
    
    Returns:
    
    ExecCreation
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execStart
```
public LogStream execStart(String execId,
                           DockerClient.ExecStartParameter... params)
                    throws DockerException,
                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Starts a previously set up exec instance id. If detach is true, this API returns after starting the exec command. Otherwise, this API sets up an interactive session with the exec command.
    
    Specified by:
    
    execStart in interface DockerClient
    
    Parameters:
    
    execId - exec id
    
    params - Exec start params
    
    Returns:
    
    exec output
    
    Throws:
    
    ExecNotFoundException - if exec instance is not found (404)
    
    ExecStartConflictException - if container is paused (409)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectSwarm
```
public Swarm inspectSwarm()
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect the Swarm cluster. Only available in Docker API >= 1.24.
    
    Specified by:
    
    inspectSwarm in interface DockerClient
    
    Returns:
    
    Info about a swarm
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createService
```
public ServiceCreateResponse createService(ServiceSpec spec)
                                    throws DockerException,
                                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new service. Only available in Docker API >= 1.24.
    
    Specified by:
    
    createService in interface DockerClient
    
    Parameters:
    
    spec - the service spec
    
    Returns:
    
    Service creation result with service id.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createService
```
public ServiceCreateResponse createService(ServiceSpec spec,
                                           AuthConfig config)
                                    throws DockerException,
                                           InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new service. Only available in Docker API >= 1.24.
    
    Specified by:
    
    createService in interface DockerClient
    
    Parameters:
    
    spec - the service spec
    
    config - the registry authentication configuration
    
    Returns:
    
    Service creation result with service id.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectService
```
public Service inspectService(String serviceId)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect an existing service. Only available in Docker API >= 1.24.
    
    Specified by:
    
    inspectService in interface DockerClient
    
    Parameters:
    
    serviceId - the id of the service to inspect
    
    Returns:
    
    Info about the service
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - updateService
```
public void updateService(String serviceId,
                          Long version,
                          ServiceSpec spec)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Update an existing service. Only available in Docker API >= 1.24.
    
    Specified by:
    
    updateService in interface DockerClient
    
    Parameters:
    
    serviceId - the identifier of the service
    
    version - the version of the service
    
    spec - the new service spec
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listServices
```
public List<Service> listServices()
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    List all services. Only available in Docker API >= 1.24.
    
    Specified by:
    
    listServices in interface DockerClient
    
    Returns:
    
    A list of services.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listServices
```
public List<Service> listServices(Service.Criteria criteria)
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    List services that match the given criteria. Only available in Docker API >= 1.24.
    
    Specified by:
    
    listServices in interface DockerClient
    
    Parameters:
    
    criteria - Service listing and filtering options.
    
    Returns:
    
    A list of Services
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeService
```
public void removeService(String serviceId)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove an existing service. Only available in Docker API >= 1.24.
    
    Specified by:
    
    removeService in interface DockerClient
    
    Parameters:
    
    serviceId - the id of the service to remove
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectTask
```
public Task inspectTask(String taskId)
                 throws DockerException,
                        InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect an existing task. Only available in Docker API >= 1.24.
    
    Specified by:
    
    inspectTask in interface DockerClient
    
    Parameters:
    
    taskId - the id of the task to inspect
    
    Returns:
    
    Info about the task
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listTasks
```
public List<Task> listTasks()
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    List all tasks. Only available in Docker API >= 1.24.
    
    Specified by:
    
    listTasks in interface DockerClient
    
    Returns:
    
    A list of tasks.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listTasks
```
public List<Task> listTasks(Task.Criteria criteria)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    List tasks that match the given criteria. Only available in Docker API >= 1.24.
    
    Specified by:
    
    listTasks in interface DockerClient
    
    Parameters:
    
    criteria - Task.Criteria
    
    Returns:
    
    A list of tasks.
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execResizeTty
```
public void execResizeTty(String execId,
                          Integer height,
                          Integer width)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Resizes the tty session used by an exec command. This API is valid only if tty was specified as part of creating and starting the exec command.
    
    Specified by:
    
    execResizeTty in interface DockerClient
    
    Parameters:
    
    execId - exec id
    
    height - height of tty session
    
    width - width of tty session
    
    Throws:
    
    BadParamException - if both height and width are null or zero
    
    ExecNotFoundException - if exec instance is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - execInspect
```
public ExecState execInspect(String execId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspects a running or previously run exec instance id.
    
    Specified by:
    
    execInspect in interface DockerClient
    
    Parameters:
    
    execId - exec id
    
    Returns:
    
    state of this exec instance.
    
    Throws:
    
    ExecNotFoundException - if exec instance is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - stats
```
public ContainerStats stats(String containerId)
                     throws DockerException,
                            InterruptedException
```
    Description copied from interface: DockerClient
    
    Retrieves one-time stats (stream=0) for the container with the specified id.
    
    Specified by:
    
    stats in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to retrieve stats for.
    
    Returns:
    
    The container stats
    
    Throws:
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - resizeTty
```
public void resizeTty(String containerId,
                      Integer height,
                      Integer width)
               throws DockerException,
                      InterruptedException
```
    Description copied from interface: DockerClient
    
    Resize container TTY This API is valid only if tty was specified as part of creating the container.
    
    Specified by:
    
    resizeTty in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container whose TTY will be resized.
    
    height - New height of TTY
    
    width - New width of TTY
    
    Throws:
    
    BadParamException - if both height and width are null or zero
    
    ContainerNotFoundException - if container is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - listNetworks
```
public List<Network> listNetworks()
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    List all networks.
    
    Specified by:
    
    listNetworks in interface DockerClient
    
    Returns:
    
    networks
    
    Throws:
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - inspectNetwork
```
public Network inspectNetwork(String networkId)
                       throws DockerException,
                              InterruptedException
```
    Description copied from interface: DockerClient
    
    Inspect a specific network.
    
    Specified by:
    
    inspectNetwork in interface DockerClient
    
    Parameters:
    
    networkId - The id of the network
    
    Returns:
    
    network information
    
    Throws:
    
    NetworkNotFoundException - if network is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createNetwork
```
public NetworkCreation createNetwork(NetworkConfig networkConfig)
                              throws DockerException,
                                     InterruptedException
```
    Description copied from interface: DockerClient
    
    Create a new network.
    
    Specified by:
    
    createNetwork in interface DockerClient
    
    Parameters:
    
    networkConfig - The network creation parameters
    
    Returns:
    
    NetworkCreation
    
    Throws:
    
    NetworkNotFoundException - if network is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - removeNetwork
```
public void removeNetwork(String networkId)
                   throws DockerException,
                          InterruptedException
```
    Description copied from interface: DockerClient
    
    Remove a docker network.
    
    Specified by:
    
    removeNetwork in interface DockerClient
    
    Parameters:
    
    networkId - The id of the network to remove.
    
    Throws:
    
    NetworkNotFoundException - if network is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - connectToNetwork
```
public void connectToNetwork(String containerId,
                             String networkId)
                      throws DockerException,
                             InterruptedException
```
    Description copied from interface: DockerClient
    
    Connects a docker container to a network.
    
    Specified by:
    
    connectToNetwork in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to connect.
    
    networkId - The id of the network to connect.
    
    Throws:
    
    NotFoundException - if either container or network is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - disconnectFromNetwork
```
public void disconnectFromNetwork(String containerId,
                                  String networkId)
                           throws DockerException,
                                  InterruptedException
```
    Description copied from interface: DockerClient
    
    Disconnects a docker container to a network.
    
    Specified by:
    
    disconnectFromNetwork in interface DockerClient
    
    Parameters:
    
    containerId - The id of the container to disconnect.
    
    networkId - The id of the network to disconnect.
    
    Throws:
    
    NotFoundException - if either container or network is not found (404)
    
    DockerException - if a server error occurred (500)
    
    InterruptedException - If the thread is interrupted
  - createVolume
```
public Volume createVolume()
                    throws DockerException,
                           InterruptedException
```
    Specified by:
    
    createVolume in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - createVolume
```
public Volume createVolume(Volume volume)
                    throws DockerException,
                           InterruptedException
```
    Specified by:
    
    createVolume in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - inspectVolume
```
public Volume inspectVolume(String volumeName)
                     throws DockerException,
                            InterruptedException
```
    Specified by:
    
    inspectVolume in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - removeVolume
```
public void removeVolume(Volume volume)
                  throws DockerException,
                         InterruptedException
```
    Specified by:
    
    removeVolume in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - removeVolume
```
public void removeVolume(String volumeName)
                  throws DockerException,
                         InterruptedException
```
    Specified by:
    
    removeVolume in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - listVolumes
```
public VolumeList listVolumes(DockerClient.ListVolumesParam... params)
                       throws DockerException,
                              InterruptedException
```
    Specified by:
    
    listVolumes in interface DockerClient
    
    Throws:
    
    DockerException
    
    InterruptedException
  - builder
```
public static DefaultDockerClient.Builder builder()
```
    Create a new DefaultDockerClient builder.
    
    Returns:
    
    Returns a builder that can be used to further customize and then build the client.
  - fromEnv
```
public static DefaultDockerClient.Builder fromEnv()
                                           throws DockerCertificateException
```
    Create a new DefaultDockerClient builder prepopulated with values loaded from the DOCKER_HOST and DOCKER_CERT_PATH environment variables.
    
    Returns:
    
    Returns a builder that can be used to further customize and then build the client.
    
    Throws:
    
    DockerCertificateException - if we could not build a DockerCertificates object

Class DefaultDockerClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.spotify.docker.client.DockerClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultDockerClient

DefaultDockerClient

DefaultDockerClient

DefaultDockerClient

Method Detail

getHost

close

ping

version

auth

info

listContainers

listImages

createContainer

createContainer

startContainer

pauseContainer

unpauseContainer

restartContainer

restartContainer

killContainer

stopContainer

waitContainer

removeContainer

removeContainer

removeContainer

exportContainer

copyContainer

archiveContainer

topContainer

topContainer

copyToContainer

inspectContainerChanges

inspectContainer

commitContainer

renameContainer

searchImages

load

load

load

load

load

create

create

save

save

saveMultiple

pull

pull

pull

pull

push

push

push

push

tag

tag

build

build

build

build

build

inspectImage

removeImage

removeImage

history

logs

events

attachContainer

execCreate

execStart

inspectSwarm

createService