クラス DockerApi.ImageApi
java.lang.ObjectSE
org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
- 含まれているクラス:
- DockerApi
イメージ操作用の Docker API。
メソッドのサマリー
修飾子と型メソッド説明void
exportLayerFiles
(ImageReference reference, IOBiConsumer<StringSE, PathSE> exports) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。void
exportLayers
(ImageReference reference, IOBiConsumer<StringSE, TarArchive> exports) イメージのレイヤーをTarArchives
としてエクスポートします。inspect
(ImageReference reference) イメージを調べます。void
load
(ImageArchive archive, UpdateListener<LoadImageUpdateEvent> listener) ImageArchive
を Docker にロードします。pull
(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener) レジストリからイメージをプルします。pull
(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener, StringSE registryAuth) レジストリからイメージをプルします。void
push
(ImageReference reference, UpdateListener<PushImageUpdateEvent> listener, StringSE registryAuth) イメージをレジストリにプッシュします。void
remove
(ImageReference reference, boolean force) 特定のイメージを削除します。void
tag
(ImageReference sourceReference, ImageReference targetReference)
メソッドの詳細
pull
public Image pull(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener) throws IOExceptionSE レジストリからイメージをプルします。- パラメーター:
reference
- プルするイメージ参照listener
- 更新イベントを受信するためのプルリスナー- 戻り値:
pulled image
インスタンス- 例外:
IOExceptionSE
- IO エラー時
pull
public Image pull(ImageReference reference, UpdateListener<PullImageUpdateEvent> listener, StringSE registryAuth) throws IOExceptionSE レジストリからイメージをプルします。- パラメーター:
reference
- プルするイメージ参照listener
- 更新イベントを受信するためのプルリスナーregistryAuth
- レジストリ認証資格情報- 戻り値:
pulled image
インスタンス- 例外:
IOExceptionSE
- IO エラー時
push
public void push(ImageReference reference, UpdateListener<PushImageUpdateEvent> listener, StringSE registryAuth) throws IOExceptionSE イメージをレジストリにプッシュします。- パラメーター:
reference
- プッシュするイメージ参照listener
- 更新イベントを受信するためのプッシュリスナーregistryAuth
- レジストリ認証資格情報- 例外:
IOExceptionSE
- IO エラー時
load
public void load(ImageArchive archive, UpdateListener<LoadImageUpdateEvent> listener) throws IOExceptionSE ImageArchive
を Docker にロードします。- パラメーター:
archive
- ロードするアーカイブlistener
- 更新イベントを受信するためのプルリスナー- 例外:
IOExceptionSE
- IO エラー時
exportLayerFiles
@DeprecatedSE(since="3.2.6", forRemoval=true) public void exportLayerFiles(ImageReference reference, IOBiConsumer<StringSE, PathSE> exports) throws IOExceptionSE非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。3.2.6 以降、3.5.0 で削除されexportLayers(ImageReference, IOBiConsumer)
を推奨イメージのレイヤーをレイヤー tar ファイルへのパスとしてエクスポートします。- パラメーター:
reference
- エクスポートへの参照exports
- レイヤーの tar ファイルのパスを受け取るコンシューマー (ファイルにはコールバック中にのみアクセスできます)- 例外:
IOExceptionSE
- IO エラー時- 導入:
- 2.7.10
exportLayers
public void exportLayers(ImageReference reference, IOBiConsumer<StringSE, TarArchive> exports) throws IOExceptionSEイメージのレイヤーをTarArchives
としてエクスポートします。- パラメーター:
reference
- エクスポートへの参照exports
- レイヤーを受け取るコンシューマー (コンテンツには、コールバック中にのみアクセスできます)- 例外:
IOExceptionSE
- IO エラー時
remove
特定のイメージを削除します。- パラメーター:
reference
- 参照削除force
- 削除を強制する必要がある場合- 例外:
IOExceptionSE
- IO エラー時
inspect
イメージを調べます。- パラメーター:
reference
- イメージ参照- 戻り値:
- ローカルリポジトリからのイメージ
- 例外:
IOExceptionSE
- IO エラー時
tag
public void tag(ImageReference sourceReference, ImageReference targetReference) throws IOExceptionSE
exportLayers(ImageReference, IOBiConsumer)
を推奨