インターフェース DockerCompose
public interface DockerCompose
Docker compose と連携するための高レベル API を提供します。
- 導入:
- 3.1.0
- 作成者:
- Moritz Halbritter, Andy Wilkinson, Phillip Webb
フィールドサマリー
フィールドメソッドのサマリー
修飾子と型メソッド説明void
down
(DurationSE timeout) docker compose down
を実行して、実行中のサービスを停止して削除します。static DockerCompose
get
(DockerComposeFile file, StringSE hostname, SetSE<StringSE> activeProfiles) DockerCompose
インスタンスの作成に使用されるファクトリメソッド。アクティブなプロファイルの実行中のサービスを返すか、実行中のサービスがない場合は空のリストを返します。boolean
アクティブなプロファイルのサービスがDockerComposeFile
で定義されているかどうかを返します。void
docker compose start
を実行してサービスを開始します。void
stop
(DurationSE timeout) docker compose stop
を実行して、実行中のサービスを停止します。void
docker compose up
を実行してサービスを作成し、開始します。
フィールドの詳細
FORCE_STOP
強制停止をリクエストするために使用されるタイムアウト期間。
メソッドの詳細
up
docker compose up
を実行してサービスを作成し、開始します。すべてのコンテナーが開始され、正常になるまで待機します。- パラメーター:
logLevel
- 進行状況を報告するために使用されるログレベル
down
docker compose down
を実行して、実行中のサービスを停止して削除します。- パラメーター:
timeout
- 待機する時間、または待機せずに停止するFORCE_STOP
。
start
docker compose start
を実行してサービスを開始します。すべてのコンテナーが起動され、正常になるまで待機します。- パラメーター:
logLevel
- 進行状況を報告するために使用されるログレベル
stop
docker compose stop
を実行して、実行中のサービスを停止します。- パラメーター:
timeout
- 待機する時間、または待機せずに停止するFORCE_STOP
。
hasDefinedServices
boolean hasDefinedServices()アクティブなプロファイルのサービスがDockerComposeFile
で定義されているかどうかを返します。- 戻り値:
true
(サービスが定義されている場合)- 関連事項:
getRunningServices
ListSE<RunningService> getRunningServices()アクティブなプロファイルの実行中のサービスを返すか、実行中のサービスがない場合は空のリストを返します。- 戻り値:
- 実行中のサービスのリスト
get
DockerCompose
インスタンスの作成に使用されるファクトリメソッド。- パラメーター:
file
- docker compose ファイルhostname
- サービスに使用されるホスト名、またはホスト名を推測する必要がある場合はnull
activeProfiles
- アクティブ化する必要があるプロファイルのセット- 戻り値:
DockerCompose
インスタンス