org.springframework.boot.gradle.tasks.bundling

Class BootBuildImage

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.springframework.boot.gradle.tasks.bundling.BootBuildImage

All Implemented Interfaces:

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

A Task for bundling an application into an OCI image using a buildpack.

Since:

2.3.0

Author:

Andy Wilkinson, Scott Frederick

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
BootBuildImage()

Method Summary

Modifier and Type	Method and Description
void	docker(org.gradle.api.Action<DockerSpec> action) Configures the Docker connection using the given action.
void	docker(groovy.lang.Closure<?> closure) Configures the Docker connection using the given closure.
void	environment(java.util.Map<java.lang.String,java.lang.String> entries) Adds entries to the environment that will be used when building the image.
void	environment(java.lang.String name, java.lang.String value) Add an entry to the environment that will be used when building the image.
java.lang.String	getBuilder() Returns the builder that will be used to build the image.
DockerSpec	getDocker() Returns the Docker configuration the builder will use.
java.util.Map<java.lang.String,java.lang.String>	getEnvironment() Returns the environment that will be used when building the image.
java.lang.String	getImageName() Returns the name of the image that will be built.
org.gradle.api.file.RegularFileProperty	getJar() Returns the property for the jar file from which the image will be built.
org.springframework.boot.buildpack.platform.build.PullPolicy	getPullPolicy() Returns image pull policy that will be used when building the image.
java.lang.String	getRunImage() Returns the run image that will be included in the built image.
org.gradle.api.provider.Property<org.gradle.api.JavaVersion>	getTargetJavaVersion() Returns the target Java version of the project (e.g.
boolean	isCleanCache() Returns whether caches should be cleaned before packaging.
boolean	isPublish() Whether the built image should be pushed to a registry.
boolean	isVerboseLogging() Whether verbose logging should be enabled while building the image.
void	setBuilder(java.lang.String builder) Sets the builder that will be used to build the image.
void	setCleanCache(boolean cleanCache) Sets whether caches should be cleaned before packaging.
void	setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) Sets the environment that will be used when building the image.
void	setImageName(java.lang.String imageName) Sets the name of the image that will be built.
void	setPublish(boolean publish) Sets whether the built image should be pushed to a registry.
void	setPullPolicy(org.springframework.boot.buildpack.platform.build.PullPolicy pullPolicy) Sets image pull policy that will be used when building the image.
void	setRunImage(java.lang.String runImage) Sets the run image that will be included in the built image.
void	setVerboseLogging(boolean verboseLogging) Sets whether verbose logging should be enabled while building the image.

Methods inherited from class 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

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, replaceLogger, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

getConvention

Constructor Detail

BootBuildImage

public BootBuildImage()

Method Detail

getJar

@Input
public org.gradle.api.file.RegularFileProperty getJar()

Returns the property for the jar file from which the image will be built.

Returns:

the jar property

getTargetJavaVersion

@Input
 @Optional
public org.gradle.api.provider.Property<org.gradle.api.JavaVersion> getTargetJavaVersion()

Returns the target Java version of the project (e.g. as provided by the targetCompatibility build property).

Returns:

the target Java version

getImageName

@Input
 @Optional
public java.lang.String getImageName()

Returns the name of the image that will be built. When null, the name will be derived from the Project's name and version.

Returns:

name of the image

setImageName

public void setImageName(java.lang.String imageName)

Sets the name of the image that will be built.

Parameters:

imageName - name of the image

getBuilder

@Input
 @Optional
public java.lang.String getBuilder()

Returns the builder that will be used to build the image. When null, the default builder will be used.

Returns:

the builder

setBuilder

public void setBuilder(java.lang.String builder)

Sets the builder that will be used to build the image.

Parameters:

builder - the builder

getRunImage

@Input
 @Optional
public java.lang.String getRunImage()

Returns the run image that will be included in the built image. When null, the run image bundled with the builder will be used.

Returns:

the run image

setRunImage

public void setRunImage(java.lang.String runImage)

Sets the run image that will be included in the built image.

Parameters:

runImage - the run image

getEnvironment

@Input
public java.util.Map<java.lang.String,java.lang.String> getEnvironment()

Returns the environment that will be used when building the image.

Returns:

the environment

setEnvironment

public void setEnvironment(java.util.Map<java.lang.String,java.lang.String> environment)

Sets the environment that will be used when building the image.

Parameters:

environment - the environment

environment

public void environment(java.lang.String name,
                        java.lang.String value)

Add an entry to the environment that will be used when building the image.

Parameters:

name - the name of the entry

value - the value of the entry

environment

public void environment(java.util.Map<java.lang.String,java.lang.String> entries)

Adds entries to the environment that will be used when building the image.

Parameters:

entries - the entries to add to the environment

isCleanCache

@Input
public boolean isCleanCache()

Returns whether caches should be cleaned before packaging.

Returns:

whether caches should be cleaned

setCleanCache

public void setCleanCache(boolean cleanCache)

Sets whether caches should be cleaned before packaging.

Parameters:

cleanCache - true to clean the cache, otherwise false.

isVerboseLogging

@Input
public boolean isVerboseLogging()

Whether verbose logging should be enabled while building the image.

Returns:

whether verbose logging should be enabled

setVerboseLogging

public void setVerboseLogging(boolean verboseLogging)

Sets whether verbose logging should be enabled while building the image.

Parameters:

verboseLogging - true to enable verbose logging, otherwise false.

getPullPolicy

@Input
 @Optional
public org.springframework.boot.buildpack.platform.build.PullPolicy getPullPolicy()

Returns image pull policy that will be used when building the image.

Returns:

whether images should be pulled

setPullPolicy

public void setPullPolicy(org.springframework.boot.buildpack.platform.build.PullPolicy pullPolicy)

Sets image pull policy that will be used when building the image.

Parameters:

pullPolicy - image pull policy PullPolicy

isPublish

@Input
public boolean isPublish()

Whether the built image should be pushed to a registry.

Returns:

whether the built image should be pushed

setPublish

public void setPublish(boolean publish)

Sets whether the built image should be pushed to a registry.

Parameters:

publish - true the push the built image to a registry. false.

getDocker

public DockerSpec getDocker()

Returns the Docker configuration the builder will use.

Returns:

docker configuration.

Since:

2.4.0

docker

public void docker(org.gradle.api.Action<DockerSpec> action)

Configures the Docker connection using the given action.

Parameters:

action - the action to apply

Since:

2.4.0

docker

public void docker(groovy.lang.Closure<?> closure)

Configures the Docker connection using the given closure.

Parameters:

closure - the closure to apply

Since:

2.4.0