Class DockerApi.ContainerApi

java.lang.Object

org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi

Enclosing class:

DockerApi

public class DockerApi.ContainerApi
extends Object

Docker API for container operations.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick, Rafael Ceccone, Moritz Halbritter

Method Summary

Modifier and Type	Method	Description
ContainerReference	create(ContainerConfig config, ImagePlatform platform, ContainerContent... contents)	Create a new container a ContainerConfig.
void	logs(ContainerReference reference, UpdateListener<LogUpdateEvent> listener)	Return and follow logs for a specific container.
void	remove(ContainerReference reference, boolean force)	Remove a specific container.
void	start(ContainerReference reference)	Start a specific container.
ContainerStatus	wait(ContainerReference reference)	Wait for a container to stop and retrieve the status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public ContainerReference create(ContainerConfig config,
 ImagePlatform platform,
 ContainerContent... contents)
                          throws IOException

Create a new container a ContainerConfig.

Parameters:

config - the container config

platform - the platform (os/architecture/variant) of the image the container should be created from

contents - additional contents to include

Returns:

a ContainerReference for the newly created container

Throws:

IOException - on IO error

start

public void start(ContainerReference reference)
           throws IOException

Start a specific container.

Parameters:

reference - the container reference to start

Throws:

IOException - on IO error

logs

public void logs(ContainerReference reference,
 UpdateListener<LogUpdateEvent> listener)
          throws IOException

Return and follow logs for a specific container.

Parameters:

reference - the container reference

listener - a listener to receive log update events

Throws:

IOException - on IO error

wait

public ContainerStatus wait(ContainerReference reference)
                     throws IOException

Wait for a container to stop and retrieve the status.

Parameters:

reference - the container reference

Returns:

a ContainerStatus indicating the exit status of the container

Throws:

IOException - on IO error

remove

public void remove(ContainerReference reference,
 boolean force)
            throws IOException

Remove a specific container.

Parameters:

reference - the container to remove

force - if removal should be forced

Throws:

IOException - on IO error