Package org.springframework.boot.buildpack.platform.docker

Class DockerApi

java.lang.Object

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

public class DockerApi
extends Object

Provides access to the limited set of Docker APIs needed by pack.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick, Rafael Ceccone, Moritz Halbritter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DockerApi.ContainerApi	Docker API for container operations.
class	DockerApi.ImageApi	Docker API for image operations.
class	DockerApi.VolumeApi	Docker API for volume operations.

Constructor Summary

Constructors

Constructor	Description
DockerApi()	Create a new DockerApi instance.
DockerApi(DockerConfiguration.DockerHostConfiguration dockerHost)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.5.0 for removal in 4.0.0 in favor of DockerApi(DockerConnectionConfiguration, DockerLog)
DockerApi(DockerConnectionConfiguration connectionConfiguration, DockerLog log)	Create a new DockerApi instance.

Method Summary

Modifier and Type	Method	Description
DockerApi.ContainerApi	container()	Return the Docker API for container operations.
DockerApi.ImageApi	image()	Return the Docker API for image operations.
DockerApi.VolumeApi	volume()

Methods inherited from class java.lang.Object

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

Constructor Details

DockerApi

public DockerApi()

Create a new DockerApi instance.

DockerApi

@Deprecated(since="3.5.0",
            forRemoval=true)
public DockerApi(DockerConfiguration.DockerHostConfiguration dockerHost)

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.5.0 for removal in 4.0.0 in favor of DockerApi(DockerConnectionConfiguration, DockerLog)

Create a new DockerApi instance.

Parameters:

dockerHost - the Docker daemon host information

Since:

2.4.0

DockerApi

public DockerApi(DockerConnectionConfiguration connectionConfiguration,
 DockerLog log)

Create a new DockerApi instance.

Parameters:

connectionConfiguration - the connection configuration to use

log - a logger used to record output

Since:

3.5.0

Method Details

image

public DockerApi.ImageApi image()

Return the Docker API for image operations.

Returns:

the image API

container

public DockerApi.ContainerApi container()

Return the Docker API for container operations.

Returns:

the container API

volume

public DockerApi.VolumeApi volume()