程序包 org.springframework.boot.buildpack.platform.docker

类 DockerApi.ImageApi

java.lang.Object

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

封闭类:

DockerApi

public class DockerApi.ImageApi
extends Object

Docker API for image operations.

方法概要

修饰符和类型	方法	说明
void	exportLayerFiles(ImageReference reference, IOBiConsumer<String,Path> exports)	已过时, 待删除: 此 API 元素将从以后的版本中删除。 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)

从类继承的方法 java.lang.Object

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

方法详细资料

pull

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

Pull an image from a registry.

参数:

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

返回:

the pulled image instance

抛出:

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.

参数:

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

返回:

the pulled image instance

抛出:

IOException - on IO error

push

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

Push an image to a registry.

参数:

reference - the image reference to push

listener - a push listener to receive update events

registryAuth - registry authentication credentials

抛出:

IOException - on IO error

load

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

Load an ImageArchive into Docker.

参数:

archive - the archive to load

listener - a pull listener to receive update events

抛出:

IOException - on IO error

exportLayerFiles

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

已过时, 待删除: 此 API 元素将从以后的版本中删除。

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.

参数:

reference - the reference to export

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

抛出:

IOException - on IO error

从以下版本开始:

2.7.10

exportLayers

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

Export the layers of an image as TarArchives.

参数:

reference - the reference to export

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

抛出:

IOException - on IO error

remove

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

Remove a specific image.

参数:

reference - the reference the remove

force - if removal should be forced

抛出:

IOException - on IO error

inspect

public Image inspect(ImageReference reference)
              throws IOException

Inspect an image.

参数:

reference - the image reference

返回:

the image from the local repository

抛出:

IOException - on IO error

tag

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

抛出:

IOException