com.github.dockerjava.api

Interface DockerClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DockerClientDelegate

public interface DockerClient
extends Closeable

Method Summary

Modifier and Type	Method and Description
AttachContainerCmd	attachContainerCmd(String containerId)
AuthCmd	authCmd() Authenticate with the server, useful for checking authentication.
AuthConfig	authConfig()
BuildImageCmd	buildImageCmd()
BuildImageCmd	buildImageCmd(File dockerFileOrFolder)
BuildImageCmd	buildImageCmd(InputStream tarInputStream)
void	close()
CommitCmd	commitCmd(String containerId)
ConnectToNetworkCmd	connectToNetworkCmd()
ContainerDiffCmd	containerDiffCmd(String containerId)
CopyArchiveFromContainerCmd	copyArchiveFromContainerCmd(String containerId, String resource) Copy resource from container to local machine.
CopyArchiveToContainerCmd	copyArchiveToContainerCmd(String containerId) Copy archive from local machine to remote container
CopyFileFromContainerCmd	copyFileFromContainerCmd(String containerId, String resource) Deprecated. since docker API version 1.20, replaced by copyArchiveFromContainerCmd(String, String) since 1.24 fails.
CreateConfigCmd	createConfigCmd() Command to create a config in a docker swarm.
CreateContainerCmd	createContainerCmd(String image)
CreateImageCmd	createImageCmd(String repository, InputStream imageStream)
CreateNetworkCmd	createNetworkCmd()
CreateSecretCmd	createSecretCmd(SecretSpec secretSpec) Command to create a secret in a docker swarm.
CreateServiceCmd	createServiceCmd(ServiceSpec serviceSpec) Command to create a service in a docker swarm.
CreateVolumeCmd	createVolumeCmd()
DisconnectFromNetworkCmd	disconnectFromNetworkCmd()
EventsCmd	eventsCmd()
ExecCreateCmd	execCreateCmd(String containerId)
ExecStartCmd	execStartCmd(String execId)
InfoCmd	infoCmd()
InitializeSwarmCmd	initializeSwarmCmd(SwarmSpec swarmSpec) Enables swarm mode for the docker engine and creates a new swarm cluster
InspectConfigCmd	inspectConfigCmd(String configId) Command to inspect a service
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectExecCmd	inspectExecCmd(String execId)
InspectImageCmd	inspectImageCmd(String imageId)
InspectNetworkCmd	inspectNetworkCmd()
InspectServiceCmd	inspectServiceCmd(String serviceId) Command to inspect a service
InspectSwarmCmd	inspectSwarmCmd() Gets information about the swarm the docker engine is currently in
InspectVolumeCmd	inspectVolumeCmd(String name)
JoinSwarmCmd	joinSwarmCmd() Enables swarm mode for the docker engine and joins an existing swarm cluster
KillContainerCmd	killContainerCmd(String containerId)
LeaveSwarmCmd	leaveSwarmCmd() Disables swarm node for the docker engine and leaves the swarm cluster
ListConfigsCmd	listConfigsCmd() Command to list all configs.
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
ListNetworksCmd	listNetworksCmd()
ListSecretsCmd	listSecretsCmd() Command to list all secrets.
ListServicesCmd	listServicesCmd() Command to list all services in a docker swarm.
ListSwarmNodesCmd	listSwarmNodesCmd() List nodes in swarm
ListTasksCmd	listTasksCmd() List tasks in the swarm cluster
ListVolumesCmd	listVolumesCmd()
LoadImageCmd	loadImageCmd(InputStream imageStream) Loads a tarball with a set of images and tags into a Docker repository.
LogContainerCmd	logContainerCmd(String containerId)
LogSwarmObjectCmd	logServiceCmd(String serviceId) Command to get service log
LogSwarmObjectCmd	logTaskCmd(String taskId) Command to get task log
PauseContainerCmd	pauseContainerCmd(String containerId)
PingCmd	pingCmd()
PruneCmd	pruneCmd(PruneType pruneType) Command to delete unused containers/images/networks/volumes
PullImageCmd	pullImageCmd(String repository) * IMAGE API *
PushImageCmd	pushImageCmd(Identifier identifier)
PushImageCmd	pushImageCmd(String name)
RemoveConfigCmd	removeConfigCmd(String configId) Command to remove a config
RemoveContainerCmd	removeContainerCmd(String containerId)
RemoveImageCmd	removeImageCmd(String imageId)
RemoveNetworkCmd	removeNetworkCmd(String networkId)
RemoveSecretCmd	removeSecretCmd(String secretId) Command to remove a secret
RemoveServiceCmd	removeServiceCmd(String serviceId) Command to remove a service
RemoveVolumeCmd	removeVolumeCmd(String name)
RenameContainerCmd	renameContainerCmd(String containerId) Rename container.
ResizeContainerCmd	resizeContainerCmd(String containerId)
ResizeExecCmd	resizeExecCmd(String execId)
RestartContainerCmd	restartContainerCmd(String containerId)
SaveImageCmd	saveImageCmd(String name)
SaveImagesCmd	saveImagesCmd() Command to download multiple images at once.
SearchImagesCmd	searchImagesCmd(String term)
StartContainerCmd	startContainerCmd(String containerId) Creates a new StartContainerCmd for the container with the given ID.
StatsCmd	statsCmd(String containerId)
StopContainerCmd	stopContainerCmd(String containerId)
TagImageCmd	tagImageCmd(String imageId, String imageNameWithRepository, String tag)
TopContainerCmd	topContainerCmd(String containerId)
UnpauseContainerCmd	unpauseContainerCmd(String containerId)
UpdateContainerCmd	updateContainerCmd(String containerId) Update container settings
UpdateServiceCmd	updateServiceCmd(String serviceId, ServiceSpec serviceSpec) Command to update a service specification
UpdateSwarmCmd	updateSwarmCmd(SwarmSpec swarmSpec) Updates the swarm specification
UpdateSwarmNodeCmd	updateSwarmNodeCmd() Updates the swarm node
VersionCmd	versionCmd()
WaitContainerCmd	waitContainerCmd(String containerId)

Method Detail

authConfig

AuthConfig authConfig()
               throws DockerException

Throws:

DockerException

authCmd

AuthCmd authCmd()

Authenticate with the server, useful for checking authentication.

infoCmd

InfoCmd infoCmd()

pingCmd

PingCmd pingCmd()

versionCmd

VersionCmd versionCmd()

pullImageCmd

PullImageCmd pullImageCmd(@Nonnull
                          String repository)

* IMAGE API *

pushImageCmd

PushImageCmd pushImageCmd(@Nonnull
                          String name)

pushImageCmd

PushImageCmd pushImageCmd(@Nonnull
                          Identifier identifier)

createImageCmd

CreateImageCmd createImageCmd(@Nonnull
                              String repository,
                              @Nonnull
                              InputStream imageStream)

loadImageCmd

LoadImageCmd loadImageCmd(@Nonnull
                          InputStream imageStream)

Loads a tarball with a set of images and tags into a Docker repository. Corresponds to POST /images/load API endpoint.

Parameters:

imageStream - stream of the tarball file

Returns:

created command

Since:

RemoteApiVersion#VERSION_1_7

searchImagesCmd

SearchImagesCmd searchImagesCmd(@Nonnull
                                String term)

removeImageCmd

RemoveImageCmd removeImageCmd(@Nonnull
                              String imageId)

listImagesCmd

ListImagesCmd listImagesCmd()

inspectImageCmd

InspectImageCmd inspectImageCmd(@Nonnull
                                String imageId)

saveImageCmd

SaveImageCmd saveImageCmd(@Nonnull
                          String name)

Parameters:

name - The name, e.g. "alexec/busybox" or just "busybox" if you want to default. Not null.

saveImagesCmd

SaveImagesCmd saveImagesCmd()

Command to download multiple images at once.

Returns:

command (builder)

listContainersCmd

ListContainersCmd listContainersCmd()

* CONTAINER API *

createContainerCmd

CreateContainerCmd createContainerCmd(@Nonnull
                                      String image)

startContainerCmd

StartContainerCmd startContainerCmd(@Nonnull
                                    String containerId)

Creates a new StartContainerCmd for the container with the given ID. The command can then be further customized by using builder methods on it like StartContainerCmd#withDns(String...).

If you customize the command, any existing configuration of the target container will get reset to its default before applying the new configuration. To preserve the existing configuration, use an unconfigured StartContainerCmd.

This command corresponds to the /containers/{id}/start endpoint of the Docker Remote API.

execCreateCmd

ExecCreateCmd execCreateCmd(@Nonnull
                            String containerId)

resizeExecCmd

ResizeExecCmd resizeExecCmd(@Nonnull
                            String execId)

inspectContainerCmd

InspectContainerCmd inspectContainerCmd(@Nonnull
                                        String containerId)

removeContainerCmd

RemoveContainerCmd removeContainerCmd(@Nonnull
                                      String containerId)

waitContainerCmd

WaitContainerCmd waitContainerCmd(@Nonnull
                                  String containerId)

attachContainerCmd

AttachContainerCmd attachContainerCmd(@Nonnull
                                      String containerId)

execStartCmd

ExecStartCmd execStartCmd(@Nonnull
                          String execId)

inspectExecCmd

InspectExecCmd inspectExecCmd(@Nonnull
                              String execId)

logContainerCmd

LogContainerCmd logContainerCmd(@Nonnull
                                String containerId)

copyArchiveFromContainerCmd

CopyArchiveFromContainerCmd copyArchiveFromContainerCmd(@Nonnull
                                                        String containerId,
                                                        @Nonnull
                                                        String resource)

Copy resource from container to local machine.

Parameters:

containerId - id of the container

resource - path to container's resource

Returns:

created command

Since:

RemoteApiVersion#VERSION_1_20

copyFileFromContainerCmd

@Deprecated
CopyFileFromContainerCmd copyFileFromContainerCmd(@Nonnull
                                                              String containerId,
                                                              @Nonnull
                                                              String resource)

Deprecated. since docker API version 1.20, replaced by copyArchiveFromContainerCmd(String, String) since 1.24 fails.

Copy resource from container to local machine.

Parameters:

containerId - id of the container

resource - path to container's resource

Returns:

created command

See Also:

copyArchiveFromContainerCmd(String, String)

copyArchiveToContainerCmd

CopyArchiveToContainerCmd copyArchiveToContainerCmd(@Nonnull
                                                    String containerId)

Copy archive from local machine to remote container

Parameters:

containerId - id of the container

Returns:

created command

Since:

RemoteApiVersion#VERSION_1_20

containerDiffCmd

ContainerDiffCmd containerDiffCmd(@Nonnull
                                  String containerId)

stopContainerCmd

StopContainerCmd stopContainerCmd(@Nonnull
                                  String containerId)

killContainerCmd

KillContainerCmd killContainerCmd(@Nonnull
                                  String containerId)

updateContainerCmd

UpdateContainerCmd updateContainerCmd(@Nonnull
                                      String containerId)

Update container settings

Parameters:

containerId - id of the container

Returns:

command

Since:

RemoteApiVersion#VERSION_1_22

renameContainerCmd

RenameContainerCmd renameContainerCmd(@Nonnull
                                      String containerId)

Rename container.

Parameters:

containerId - id of the container

Returns:

command

Since:

RemoteApiVersion#VERSION_1_17

restartContainerCmd

RestartContainerCmd restartContainerCmd(@Nonnull
                                        String containerId)

resizeContainerCmd

ResizeContainerCmd resizeContainerCmd(@Nonnull
                                      String containerId)

commitCmd

CommitCmd commitCmd(@Nonnull
                    String containerId)

buildImageCmd

BuildImageCmd buildImageCmd()

buildImageCmd

BuildImageCmd buildImageCmd(File dockerFileOrFolder)

buildImageCmd

BuildImageCmd buildImageCmd(InputStream tarInputStream)

topContainerCmd

TopContainerCmd topContainerCmd(String containerId)

tagImageCmd

TagImageCmd tagImageCmd(String imageId,
                        String imageNameWithRepository,
                        String tag)

pauseContainerCmd

PauseContainerCmd pauseContainerCmd(String containerId)

unpauseContainerCmd

UnpauseContainerCmd unpauseContainerCmd(String containerId)

eventsCmd

EventsCmd eventsCmd()

statsCmd

StatsCmd statsCmd(String containerId)

createVolumeCmd

CreateVolumeCmd createVolumeCmd()

inspectVolumeCmd

InspectVolumeCmd inspectVolumeCmd(String name)

removeVolumeCmd

RemoveVolumeCmd removeVolumeCmd(String name)

listVolumesCmd

ListVolumesCmd listVolumesCmd()

listNetworksCmd

ListNetworksCmd listNetworksCmd()

inspectNetworkCmd

InspectNetworkCmd inspectNetworkCmd()

createNetworkCmd

CreateNetworkCmd createNetworkCmd()

removeNetworkCmd

RemoveNetworkCmd removeNetworkCmd(@Nonnull
                                  String networkId)

connectToNetworkCmd

ConnectToNetworkCmd connectToNetworkCmd()

disconnectFromNetworkCmd

DisconnectFromNetworkCmd disconnectFromNetworkCmd()

initializeSwarmCmd

InitializeSwarmCmd initializeSwarmCmd(SwarmSpec swarmSpec)

Enables swarm mode for the docker engine and creates a new swarm cluster

Parameters:

swarmSpec - the specification for the swarm

Returns:

the command

Since:

1.24

inspectSwarmCmd

InspectSwarmCmd inspectSwarmCmd()

Gets information about the swarm the docker engine is currently in

Returns:

the command

Since:

1.24

joinSwarmCmd

JoinSwarmCmd joinSwarmCmd()

Enables swarm mode for the docker engine and joins an existing swarm cluster

Returns:

the command

Since:

1.24

leaveSwarmCmd

LeaveSwarmCmd leaveSwarmCmd()

Disables swarm node for the docker engine and leaves the swarm cluster

Returns:

the command

Since:

1.24

updateSwarmCmd

UpdateSwarmCmd updateSwarmCmd(SwarmSpec swarmSpec)

Updates the swarm specification

Parameters:

swarmSpec - the specification for the swarm

Returns:

the command

Since:

1.24

updateSwarmNodeCmd

UpdateSwarmNodeCmd updateSwarmNodeCmd()

Updates the swarm node

Returns:

the command

Since:

1.24

listSwarmNodesCmd

ListSwarmNodesCmd listSwarmNodesCmd()

List nodes in swarm

Returns:

the command

Since:

1.24

listServicesCmd

ListServicesCmd listServicesCmd()

Command to list all services in a docker swarm. Only applicable if docker runs in swarm mode.

Returns:

command

Since:

RemoteApiVersion#VERSION_1_24

createServiceCmd

CreateServiceCmd createServiceCmd(ServiceSpec serviceSpec)

Command to create a service in a docker swarm. Only applicable if docker runs in swarm mode.

Parameters:

serviceSpec - the service specification

Returns:

command

Since:

RemoteApiVersion#VERSION_1_24

inspectServiceCmd

InspectServiceCmd inspectServiceCmd(String serviceId)

Command to inspect a service

Parameters:

serviceId - service id or service name

Returns:

command

updateServiceCmd

UpdateServiceCmd updateServiceCmd(String serviceId,
                                  ServiceSpec serviceSpec)

Command to update a service specification

Parameters:

serviceId - service id

serviceSpec - the new service specification

Returns:

command

removeServiceCmd

RemoveServiceCmd removeServiceCmd(String serviceId)

Command to remove a service

Parameters:

serviceId - service id or service name

Returns:

command

listTasksCmd

ListTasksCmd listTasksCmd()

List tasks in the swarm cluster

Returns:

the command

Since:

1.24

logServiceCmd

LogSwarmObjectCmd logServiceCmd(String serviceId)

Command to get service log

Returns:

the command

Since:

1.29

logTaskCmd

LogSwarmObjectCmd logTaskCmd(String taskId)

Command to get task log

Returns:

the command

Since:

1.29

pruneCmd

PruneCmd pruneCmd(PruneType pruneType)

Command to delete unused containers/images/networks/volumes

Since:

RemoteApiVersion#VERSION_1_25

listSecretsCmd

ListSecretsCmd listSecretsCmd()

Command to list all secrets. Only applicable if docker runs in swarm mode.

Returns:

command

Since:

RemoteApiVersion#VERSION_1_25

createSecretCmd

CreateSecretCmd createSecretCmd(SecretSpec secretSpec)

Command to create a secret in a docker swarm. Only applicable if docker runs in swarm mode.

Parameters:

secretSpec - the secret specification

Returns:

command

Since:

RemoteApiVersion#VERSION_1_25

removeSecretCmd

RemoveSecretCmd removeSecretCmd(String secretId)

Command to remove a secret

Parameters:

secretId - secret id or secret name

Returns:

command

Since:

RemoteApiVersion#VERSION_1_25

listConfigsCmd

ListConfigsCmd listConfigsCmd()

Command to list all configs. Only applicable if docker runs in swarm mode.

Returns:

command

Since:

RemoteApiVersion#VERSION_1_30

createConfigCmd

CreateConfigCmd createConfigCmd()

Command to create a config in a docker swarm. Only applicable if docker runs in swarm mode.

Returns:

command

Since:

RemoteApiVersion#VERSION_1_30

inspectConfigCmd

InspectConfigCmd inspectConfigCmd(String configId)

Command to inspect a service

Parameters:

configId - config id or config name

Returns:

command

Since:

RemoteApiVersion#VERSION_1_30

removeConfigCmd

RemoveConfigCmd removeConfigCmd(String configId)

Command to remove a config

Parameters:

configId - config id or config name

Returns:

command

Since:

RemoteApiVersion#VERSION_1_30

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException