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

Class DockerApi.ImageApi

java.lang.Object

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

Enclosing class:

DockerApi

public class DockerApi.ImageApi
extends Object

Docker API for image operations.

Method Summary

Modifier and Type	Method	Description
void	exportLayerFiles(ImageReference reference, IOBiConsumer<String,Path> exports)	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2.6 for removal in 3.5.0 in favor of exportLayers(ImageReference, IOBiConsumer)
void	exportLayers(ImageReference reference, IOBiConsumer<String,TarArchive> exports)	Export the layers of an image as TarArchives.
Image	inspect(ImageReference reference)	Inspect an image.
void	load(ImageArchive archive, UpdateListener<LoadImageUpdateEvent> listener)	Load an ImageArchive into Docker.
Image	pull(ImageReference reference, ImagePlatform platform, UpdateListener<PullImageUpdateEvent> listener)	Pull an image from a registry.
Image	pull(ImageReference reference, ImagePlatform platform, UpdateListener<PullImageUpdateEvent> listener, String registryAuth)	Pull an image from a registry.
void	push(ImageReference reference, UpdateListener<PushImageUpdateEvent> listener, String registryAuth)	Push an image to a registry.
void	remove(ImageReference reference, boolean force)	Remove a specific image.
void	tag(ImageReference sourceReference, ImageReference targetReference)

Methods inherited from class java.lang.Object

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

Method Details

pull

public Image pull(ImageReference reference,
 ImagePlatform platform,
 UpdateListener<PullImageUpdateEvent> listener)
           throws IOException

Pull an image from a registry.

Parameters:

reference - the image reference to pull

platform - the platform (os/architecture/variant) of the image to pull

listener - a pull listener to receive update events

Returns:

the pulled image instance

Throws:

IOException - on IO error

pull

public Image pull(ImageReference reference,
 ImagePlatform platform,
 UpdateListener<PullImageUpdateEvent> listener,
 String registryAuth)
           throws IOException

Pull an image from a registry.

Parameters:

reference - the image reference to pull

platform - the platform (os/architecture/variant) of the image to pull

listener - a pull listener to receive update events

registryAuth - registry authentication credentials

Returns:

the pulled image instance

Throws:

IOException - on IO error

push

public void push(ImageReference reference,
 UpdateListener<PushImageUpdateEvent> listener,
 String registryAuth)
          throws IOException

Push an image to a registry.

Parameters:

reference - the image reference to push

listener - a push listener to receive update events

registryAuth - registry authentication credentials

Throws:

IOException - on IO error

load

public void load(ImageArchive archive,
 UpdateListener<LoadImageUpdateEvent> listener)
          throws IOException

Load an ImageArchive into Docker.

Parameters:

archive - the archive to load

listener - a pull listener to receive update events

Throws:

IOException - on IO error

exportLayerFiles

@Deprecated(since="3.2.6",
            forRemoval=true)
public void exportLayerFiles(ImageReference reference,
 IOBiConsumer<String,Path> exports)
                      throws IOException

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

since 3.2.6 for removal in 3.5.0 in favor of exportLayers(ImageReference, IOBiConsumer)

Export the layers of an image as paths to layer tar files.

Parameters:

reference - the reference to export

exports - a consumer to receive the layer tar file paths (file can only be accessed during the callback)

Throws:

IOException - on IO error

Since:

2.7.10

exportLayers

public void exportLayers(ImageReference reference,
 IOBiConsumer<String,TarArchive> exports)
                  throws IOException

Export the layers of an image as TarArchives.

Parameters:

reference - the reference to export

exports - a consumer to receive the layers (contents can only be accessed during the callback)

Throws:

IOException - on IO error

remove

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

Remove a specific image.

Parameters:

reference - the reference the remove

force - if removal should be forced

Throws:

IOException - on IO error

inspect

public Image inspect(ImageReference reference)
              throws IOException

Inspect an image.

Parameters:

reference - the image reference

Returns:

the image from the local repository

Throws:

IOException - on IO error

tag

public void tag(ImageReference sourceReference,
 ImageReference targetReference)
         throws IOException

Throws:

IOException