BootBuildImage (Spring Boot Gradle Plugin API)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - org.springframework.boot.gradle.tasks.bundling.BootBuildImage

実装されたすべてのインターフェース:
java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
```
public class BootBuildImage
extends org.gradle.api.DefaultTask
```
buildpack を使用してアプリケーションを OCI イメージにバンドルするための Task 。
導入:
2.3.0
作成者:
Andy Wilkinson, Scott Frederick, Rafael Ceccone, Jeroen Meijer, Julian Liebig

ネストされたクラスのサマリー
- インターフェース org.gradle.api.Task から継承されたネストクラス / インターフェース
  org.gradle.api.Task.Namer

フィールドサマリー
- インターフェース org.gradle.api.Task から継承されたフィールド
  TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
BootBuildImage()

コンストラクター
コンストラクターと説明
`BootBuildImage()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`binding(java.lang.String binding)` イメージを構築するときにコンテナーにマウントされるボリュームバインディングにエントリを追加します。
`void`	`bindings(java.util.List<java.lang.String> bindings)` イメージのビルド時にコンテナーにマウントされるボリュームバインディングにエントリを追加します。
`void`	`buildCache(org.gradle.api.Action<CacheSpec> action)` 指定された `action` を使用して、ビルドキャッシュの `CacheSpec` をカスタマイズします。
`void`	`buildCache(groovy.lang.Closure<?> closure)` 指定された `closure` を使用して、ビルドキャッシュの `CacheSpec` をカスタマイズします。
`void`	`buildpack(java.lang.String buildpack)` イメージの構築時に使用されるエントリを buildpacks に追加します。
`void`	`buildpacks(java.util.List<java.lang.String> buildpacks)` イメージの構築時に使用されるエントリを buildpacks に追加します。
`void`	`docker(org.gradle.api.Action<DockerSpec> action)` 指定された `action` を使用して Docker 接続を構成します。
`void`	`docker(groovy.lang.Closure<?> closure)` 指定された `closure` を使用して Docker 接続を構成します。
`void`	`environment(java.util.Map<java.lang.String,java.lang.String> entries)` イメージの構築時に使用される環境にエントリを追加します。
`void`	`environment(java.lang.String name, java.lang.String value)` イメージの構築時に使用される環境にエントリを追加します。
`org.gradle.api.file.RegularFileProperty`	`getArchiveFile()` イメージの作成元となるアーカイブファイルのプロパティを返します。
`java.util.List<java.lang.String>`	`getBindings()` イメージのビルド時にコンテナーにマウントされるボリュームバインディングを返します。
`CacheSpec`	`getBuildCache()` イメージのビルド時に使用されるビルドキャッシュを返します。
`java.lang.String`	`getBuilder()` イメージの構築に使用されるビルダーを返します。
`java.util.List<java.lang.String>`	`getBuildpacks()` イメージのビルド時に使用される buildpacks を返します。
`DockerSpec`	`getDocker()` ビルダーが使用する Docker 構成を返します。
`java.util.Map<java.lang.String,java.lang.String>`	`getEnvironment()` イメージの構築時に使用される環境を返します。
`java.lang.String`	`getImageName()` ビルドされるイメージの名前を返します。
`org.gradle.api.file.RegularFileProperty`	`getJar()` 使用すべきではありません。 2.5.0 以降、2.7.0 で削除され `getArchiveFile()` を推奨
`CacheSpec`	`getLaunchCache()` イメージのビルド時に使用される起動キャッシュを返します。
`java.lang.String`	`getNetwork()` ビルドコンテナーが接続するネットワークを返します。
`org.springframework.boot.buildpack.platform.build.PullPolicy`	`getPullPolicy()` イメージのビルド時に使用されるイメージプルポリシーを返します。
`java.lang.String`	`getRunImage()` ビルドされたイメージに含まれる実行イメージを返します。
`java.util.List<java.lang.String>`	`getTags()` ビルドされたイメージ用に作成されるタグを返します。
`org.gradle.api.provider.Property<org.gradle.api.JavaVersion>`	`getTargetJavaVersion()` プロジェクトのターゲット Java バージョンを返します（例:
`boolean`	`isCleanCache()` パッケージ化する前にキャッシュをクリーンアップする必要があるかどうかを返します。
`boolean`	`isPublish()` ビルドされたイメージをレジストリにプッシュする必要があるかどうか。
`boolean`	`isVerboseLogging()` イメージの構築中に詳細ログを有効にするかどうか。
`void`	`launchCache(org.gradle.api.Action<CacheSpec> action)` 指定された `action` を使用して、起動キャッシュの `CacheSpec` をカスタマイズします。
`void`	`launchCache(groovy.lang.Closure<?> closure)` 指定された `closure` を使用して、起動キャッシュの `CacheSpec` をカスタマイズします。
`void`	`setBindings(java.util.List<java.lang.String> bindings)` イメージを構築するときにコンテナーにマウントされるボリュームバインディングを設定します。
`void`	`setBuilder(java.lang.String builder)` イメージの構築に使用されるビルダーを設定します。
`void`	`setBuildpacks(java.util.List<java.lang.String> buildpacks)` イメージの構築時に使用される buildpacks を設定します。
`void`	`setCleanCache(boolean cleanCache)` パッケージ化する前にキャッシュを消去するかどうかを設定します。
`void`	`setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)` イメージの構築時に使用される環境を設定します。
`void`	`setImageName(java.lang.String imageName)` 構築するイメージの名前を設定します。
`void`	`setNetwork(java.lang.String network)` ビルドコンテナーが接続するネットワークを設定します。
`void`	`setPublish(boolean publish)` ビルドされたイメージをレジストリにプッシュするかどうかを設定します。
`void`	`setPullPolicy(org.springframework.boot.buildpack.platform.build.PullPolicy pullPolicy)` イメージの構築時に使用されるイメージプルポリシーを設定します。
`void`	`setRunImage(java.lang.String runImage)` ビルドイメージに含まれる実行イメージを設定します。
`void`	`setTags(java.util.List<java.lang.String> tags)` ビルドされたイメージ用に作成されるタグを設定します。
`void`	`setVerboseLogging(boolean verboseLogging)` イメージの構築中に詳細ログを有効にするかどうかを設定します。
`void`	`tag(java.lang.String tag)` ビルドされたイメージ用に作成されるタグにエントリを追加します。
`void`	`tags(java.util.List<java.lang.String> tags)` ビルドされたイメージ用に作成されるタグにエントリを追加します。

クラス org.gradle.api.DefaultTask から継承されたメソッド
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

クラス org.gradle.api.internal.AbstractTask から継承されたメソッド
appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects, setLoggerMessageRewriter

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インターフェース org.gradle.api.Task から継承されたメソッド
getConvention

- コンストラクターの詳細
  - BootBuildImage
```
public BootBuildImage()
```
- メソッドの詳細
  - getArchiveFile
```
@Input
public org.gradle.api.file.RegularFileProperty getArchiveFile()
```
    イメージの作成元となるアーカイブファイルのプロパティを返します。
    戻り値:
    アーカイブファイルのプロパティ
  - getJar
```
@Deprecated
 @Input
public org.gradle.api.file.RegularFileProperty getJar()
```
    非推奨。2.5.0 以降、2.7.0 で削除され getArchiveFile() を推奨
    イメージの作成元となるアーカイブファイルのプロパティを返します。
    戻り値:
    アーカイブファイルのプロパティ
  - getTargetJavaVersion
```
@Input
 @Optional
public org.gradle.api.provider.Property<org.gradle.api.JavaVersion> getTargetJavaVersion()
```
    プロジェクトのターゲット Java バージョンを返します（例: targetCompatibility ビルドプロパティによって提供される）。
    戻り値:
    ターゲット Java バージョン
  - getImageName
```
@Input
 @Optional
public java.lang.String getImageName()
```
    ビルドされるイメージの名前を返します。null の場合、名前は Project'sname、version から派生します。
    戻り値:
    イメージの名前
  - setImageName
```
public void setImageName(java.lang.String imageName)
```
    構築するイメージの名前を設定します。
    パラメーター:
    imageName - イメージの名前
  - getBuilder
```
@Input
 @Optional
public java.lang.String getBuilder()
```
    イメージの構築に使用されるビルダーを返します。null の場合、デフォルトのビルダーが使用されます。
    戻り値:
    ビルダー
  - setBuilder
```
public void setBuilder(java.lang.String builder)
```
    イメージの構築に使用されるビルダーを設定します。
    パラメーター:
    builder - ビルダー
  - getRunImage
```
@Input
 @Optional
public java.lang.String getRunImage()
```
    ビルドされたイメージに含まれる実行イメージを返します。null の場合、ビルダーにバンドルされている実行イメージが使用されます。
    戻り値:
    実行イメージ
  - setRunImage
```
public void setRunImage(java.lang.String runImage)
```
    ビルドイメージに含まれる実行イメージを設定します。
    パラメーター:
    runImage - 実行イメージ
  - getEnvironment
```
@Input
public java.util.Map<java.lang.String,java.lang.String> getEnvironment()
```
    イメージの構築時に使用される環境を返します。
    戻り値:
    環境
  - setEnvironment
```
public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)
```
    イメージの構築時に使用される環境を設定します。
    パラメーター:
    environment - 環境
  - environment
```
public void environment(java.lang.String name,
                        java.lang.String value)
```
    イメージの構築時に使用される環境にエントリを追加します。
    パラメーター:
    name - エントリの名前
    value - エントリの値
  - environment
```
public void environment(java.util.Map<java.lang.String,java.lang.String> entries)
```
    イメージの構築時に使用される環境にエントリを追加します。
    パラメーター:
    entries - 環境に追加するエントリ
  - isCleanCache
```
@Input
public boolean isCleanCache()
```
    パッケージ化する前にキャッシュをクリーンアップする必要があるかどうかを返します。
    戻り値:
    キャッシュを消去するかどうか
  - setCleanCache
```
public void setCleanCache(boolean cleanCache)
```
    パッケージ化する前にキャッシュを消去するかどうかを設定します。
    パラメーター:
    cleanCache - キャッシュをクリーンアップするための true、それ以外の場合は false。
  - isVerboseLogging
```
@Input
public boolean isVerboseLogging()
```
    イメージの構築中に詳細ログを有効にするかどうか。
    戻り値:
    詳細ログを有効にするかどうか
  - setVerboseLogging
```
public void setVerboseLogging(boolean verboseLogging)
```
    イメージの構築中に詳細ログを有効にするかどうかを設定します。
    パラメーター:
    verboseLogging - true は詳細なロギングを有効にします。それ以外の場合は false です。
  - getPullPolicy
```
@Input
 @Optional
public org.springframework.boot.buildpack.platform.build.PullPolicy getPullPolicy()
```
    イメージのビルド時に使用されるイメージプルポリシーを返します。
    戻り値:
    イメージをプルする必要があるかどうか
  - setPullPolicy
```
public void setPullPolicy(org.springframework.boot.buildpack.platform.build.PullPolicy pullPolicy)
```
    イメージの構築時に使用されるイメージプルポリシーを設定します。
    パラメーター:
    pullPolicy - イメージプルポリシー PullPolicy
  - isPublish
```
@Input
public boolean isPublish()
```
    ビルドされたイメージをレジストリにプッシュする必要があるかどうか。
    戻り値:
    ビルドされたイメージをプッシュする必要があるかどうか
  - setPublish
```
public void setPublish(boolean publish)
```
    ビルドされたイメージをレジストリにプッシュするかどうかを設定します。
    パラメーター:
    publish - true は、ビルドされたイメージをレジストリにプッシュします。false。
  - getBuildpacks
```
@Input
 @Optional
public java.util.List<java.lang.String> getBuildpacks()
```
    イメージのビルド時に使用される buildpacks を返します。
    戻り値:
    buildpack リファレンス
  - setBuildpacks
```
public void setBuildpacks(java.util.List<java.lang.String> buildpacks)
```
    イメージの構築時に使用される buildpacks を設定します。
    パラメーター:
    buildpacks - buildpack リファレンス
  - buildpack
```
public void buildpack(java.lang.String buildpack)
```
    イメージの構築時に使用されるエントリを buildpacks に追加します。
    パラメーター:
    buildpack - buildpack リファレンス
  - buildpacks
```
public void buildpacks(java.util.List<java.lang.String> buildpacks)
```
    イメージの構築時に使用されるエントリを buildpacks に追加します。
    パラメーター:
    buildpacks - buildpack リファレンス
  - getBindings
```
@Input
 @Optional
public java.util.List<java.lang.String> getBindings()
```
    イメージのビルド時にコンテナーにマウントされるボリュームバインディングを返します。
    戻り値:
    バインディング
  - setBindings
```
public void setBindings(java.util.List<java.lang.String> bindings)
```
    イメージを構築するときにコンテナーにマウントされるボリュームバインディングを設定します。
    パラメーター:
    bindings - バインディング
  - binding
```
public void binding(java.lang.String binding)
```
    イメージを構築するときにコンテナーにマウントされるボリュームバインディングにエントリを追加します。
    パラメーター:
    binding - バインディング
  - bindings
```
public void bindings(java.util.List<java.lang.String> bindings)
```
    イメージのビルド時にコンテナーにマウントされるボリュームバインディングにエントリを追加します。
    パラメーター:
    bindings - バインディング
  - getTags
```
@Input
 @Optional
public java.util.List<java.lang.String> getTags()
```
    ビルドされたイメージ用に作成されるタグを返します。
    戻り値:
    タグ
  - setTags
```
public void setTags(java.util.List<java.lang.String> tags)
```
    ビルドされたイメージ用に作成されるタグを設定します。
    パラメーター:
    tags - タグ
  - tag
```
public void tag(java.lang.String tag)
```
    ビルドされたイメージ用に作成されるタグにエントリを追加します。
    パラメーター:
    tag - タグ
  - tags
```
public void tags(java.util.List<java.lang.String> tags)
```
    ビルドされたイメージ用に作成されるタグにエントリを追加します。
    パラメーター:
    tags - タグ
  - getNetwork
```
@Input
 @Optional
public java.lang.String getNetwork()
```
    ビルドコンテナーが接続するネットワークを返します。
    戻り値:
    ネットワーク
  - setNetwork
```
public void setNetwork(java.lang.String network)
```
    ビルドコンテナーが接続するネットワークを設定します。
    パラメーター:
    network - ネットワーク
  - getBuildCache
```
@Optional
public CacheSpec getBuildCache()
```
    イメージのビルド時に使用されるビルドキャッシュを返します。
    戻り値:
    キャッシュ
  - buildCache
```
public void buildCache(org.gradle.api.Action<CacheSpec> action)
```
    指定された action を使用して、ビルドキャッシュの CacheSpec をカスタマイズします。
    パラメーター:
    action - アクション
  - buildCache
```
public void buildCache(groovy.lang.Closure<?> closure)
```
    指定された closure を使用して、ビルドキャッシュの CacheSpec をカスタマイズします。
    パラメーター:
    closure - 閉鎖
  - getLaunchCache
```
@Optional
public CacheSpec getLaunchCache()
```
    イメージのビルド時に使用される起動キャッシュを返します。
    戻り値:
    キャッシュ
  - launchCache
```
public void launchCache(org.gradle.api.Action<CacheSpec> action)
```
    指定された action を使用して、起動キャッシュの CacheSpec をカスタマイズします。
    パラメーター:
    action - アクション
  - launchCache
```
public void launchCache(groovy.lang.Closure<?> closure)
```
    指定された closure を使用して、起動キャッシュの CacheSpec をカスタマイズします。
    パラメーター:
    closure - 閉鎖
  - getDocker
```
public DockerSpec getDocker()
```
    ビルダーが使用する Docker 構成を返します。
    戻り値:
    docker 構成。
    導入:
    2.4.0
  - docker
```
public void docker(org.gradle.api.Action<DockerSpec> action)
```
    指定された action を使用して Docker 接続を構成します。
    パラメーター:
    action - 適用するアクション
    導入:
    2.4.0
  - docker
```
public void docker(groovy.lang.Closure<?> closure)
```
    指定された closure を使用して Docker 接続を構成します。
    パラメーター:
    closure - 適用する閉鎖
    導入:
    2.4.0

クラス BootBuildImage

ネストされたクラスのサマリー

インターフェース org.gradle.api.Task から継承されたネストクラス / インターフェース

フィールドサマリー

インターフェース org.gradle.api.Task から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.gradle.api.DefaultTask から継承されたメソッド

クラス org.gradle.api.internal.AbstractTask から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

インターフェース org.gradle.api.Task から継承されたメソッド

コンストラクターの詳細

BootBuildImage

メソッドの詳細

getArchiveFile

getJar

getTargetJavaVersion

getImageName

setImageName

getBuilder

setBuilder

getRunImage

setRunImage

getEnvironment

setEnvironment

environment

environment

isCleanCache

setCleanCache

isVerboseLogging

setVerboseLogging

getPullPolicy

setPullPolicy

isPublish

setPublish

getBuildpacks

setBuildpacks

buildpack

buildpacks

getBindings

setBindings

binding

bindings

getTags

setTags

tag

tags

getNetwork

setNetwork

getBuildCache

buildCache

buildCache

getLaunchCache

launchCache

launchCache

getDocker

docker

docker