com.github.dockerjava.api

Interface DockerClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DockerClientImpl

public interface DockerClient
extends Closeable

Method Summary

Methods

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)
CreateContainerCmd	createContainerCmd(String image)
CreateImageCmd	createImageCmd(String repository, InputStream imageStream)
CreateNetworkCmd	createNetworkCmd()
CreateVolumeCmd	createVolumeCmd()
DisconnectFromNetworkCmd	disconnectFromNetworkCmd()
EventsCmd	eventsCmd()
ExecCreateCmd	execCreateCmd(String containerId)
ExecStartCmd	execStartCmd(String execId)
InfoCmd	infoCmd()
InspectContainerCmd	inspectContainerCmd(String containerId)
InspectExecCmd	inspectExecCmd(String execId)
InspectImageCmd	inspectImageCmd(String imageId)
InspectNetworkCmd	inspectNetworkCmd()
InspectVolumeCmd	inspectVolumeCmd(String name)
KillContainerCmd	killContainerCmd(String containerId)
ListContainersCmd	listContainersCmd() * CONTAINER API *
ListImagesCmd	listImagesCmd()
ListNetworksCmd	listNetworksCmd()
ListVolumesCmd	listVolumesCmd()
LogContainerCmd	logContainerCmd(String containerId)
PauseContainerCmd	pauseContainerCmd(String containerId)
PingCmd	pingCmd()
PullImageCmd	pullImageCmd(String repository) * IMAGE API *
PushImageCmd	pushImageCmd(Identifier identifier)
PushImageCmd	pushImageCmd(String name)
RemoveContainerCmd	removeContainerCmd(String containerId)
RemoveImageCmd	removeImageCmd(String imageId)
RemoveNetworkCmd	removeNetworkCmd(String networkId)
RemoveVolumeCmd	removeVolumeCmd(String name)
RenameContainerCmd	renameContainerCmd(String containerId) Rename container.
RestartContainerCmd	restartContainerCmd(String containerId)
SaveImageCmd	saveImageCmd(String name)
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 repository, String tag)
TopContainerCmd	topContainerCmd(String containerId)
UnpauseContainerCmd	unpauseContainerCmd(String containerId)
UpdateContainerCmd	updateContainerCmd(String containerId) Update container settings
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)

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)

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)

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)

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)

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 repository,
                      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()

close

void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException