クラス DockerApi.ImageApi

java.lang.ObjectSE
org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
含まれているクラス:
DockerApi

public class DockerApi.ImageApi extends ObjectSE
イメージ操作用の Docker API。
導入:
2.3.0
作成者:
Phillip Webb, Scott Frederick, Rafael Ceccone, Moritz Halbritter
  • 方法の詳細

    • pull

      public Image pull(ImageReference reference, @Nullable ImagePlatform platform, UpdateListener<PullImageUpdateEvent> listener) throws IOExceptionSE
      レジストリからイメージをプルします。
      パラメーター:
      reference - プルするイメージ参照
      platform - 取得するイメージのプラットフォーム(OS/ アーキテクチャ / バリアント)
      listener - 更新イベントを受信するためのプルリスナー
      戻り値:
      pulled image インスタンス
      例外:
      IOExceptionSE - IO エラー時
    • pull

      public Image pull(ImageReference reference, @Nullable ImagePlatform platform, UpdateListener<PullImageUpdateEvent> listener, @Nullable StringSE registryAuth) throws IOExceptionSE
      レジストリからイメージをプルします。
      パラメーター:
      reference - プルするイメージ参照
      platform - 取得するイメージのプラットフォーム(OS/ アーキテクチャ / バリアント)
      listener - 更新イベントを受信するためのプルリスナー
      registryAuth - レジストリ認証資格情報
      戻り値:
      pulled image インスタンス
      例外:
      IOExceptionSE - IO エラー時
    • push

      public void push(ImageReference reference, UpdateListener<PushImageUpdateEvent> listener, @Nullable 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 エラー時
    • exportLayers

      public void exportLayers(ImageReference reference, IOBiConsumer<StringSE, TarArchive> exports) throws IOExceptionSE
      イメージのレイヤーを TarArchives としてエクスポートします。
      パラメーター:
      reference - エクスポートへの参照
      exports - レイヤーを受け取るコンシューマー (コンテンツには、コールバック中にのみアクセスできます)
      例外:
      IOExceptionSE - IO エラー時
    • exportLayers

      public void exportLayers(ImageReference reference, @Nullable ImagePlatform platform, IOBiConsumer<StringSE, TarArchive> exports) throws IOExceptionSE
      イメージのレイヤーを TarArchives としてエクスポートします。
      パラメーター:
      reference - エクスポートへの参照
      platform - エクスポートするイメージのプラットフォーム(OS/ アーキテクチャ / バリアント)。Docker の古いバージョンでは無視されます。
      exports - レイヤーを受け取るコンシューマー (コンテンツには、コールバック中にのみアクセスできます)
      例外:
      IOExceptionSE - IO エラー時
      導入:
      3.4.12
    • remove

      public void remove(ImageReference reference, boolean force) throws IOExceptionSE
      特定のイメージを削除します。
      パラメーター:
      reference - 参照削除
      force - 削除を強制する必要がある場合
      例外:
      IOExceptionSE - IO エラー時
    • inspect

      public Image inspect(ImageReference reference) throws IOExceptionSE
      イメージを調べます。
      パラメーター:
      reference - イメージ参照
      戻り値:
      ローカルリポジトリからのイメージ
      例外:
      IOExceptionSE - IO エラー時
    • inspect

      public Image inspect(ImageReference reference, @Nullable ImagePlatform platform) throws IOExceptionSE
      イメージを調べます。
      パラメーター:
      reference - イメージ参照
      platform - インスペクションするイメージのプラットフォーム(OS/ アーキテクチャ / バリアント)。Docker の古いバージョンでは無視されます。
      戻り値:
      ローカルリポジトリからのイメージ
      例外:
      IOExceptionSE - IO エラー時
      導入:
      3.4.12
    • tag

      public void tag(ImageReference sourceReference, ImageReference targetReference) throws IOExceptionSE
      例外:
      IOExceptionSE