org.springframework.boot.maven

Class Image

java.lang.Object

org.springframework.boot.maven.Image

public class Image
extends java.lang.Object

Image configuration options.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBuilder() The name of the builder image to use to create the image.
java.lang.Boolean	getCleanCache() If the cache should be cleaned before building.
java.util.Map<java.lang.String,java.lang.String>	getEnv() Environment properties that should be passed to the builder.
java.lang.String	getName() The name of the created image.
java.lang.Boolean	getPublish() If the built image should be pushed to a registry.
org.springframework.boot.buildpack.platform.build.PullPolicy	getPullPolicy() If images should be pulled from a remote repository during image build.
java.lang.String	getRunImage() The name of the run image to use to create the image.
boolean	isVerboseLogging() If verbose logging is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

public Image()

Method Detail

getName

public java.lang.String getName()

The name of the created image.

Returns:

the image name

getBuilder

public java.lang.String getBuilder()

The name of the builder image to use to create the image.

Returns:

the builder image name

getRunImage

public java.lang.String getRunImage()

The name of the run image to use to create the image.

Returns:

the builder image name

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Environment properties that should be passed to the builder.

Returns:

the environment properties

getCleanCache

public java.lang.Boolean getCleanCache()

If the cache should be cleaned before building.

Returns:

true if the cache should be cleaned

isVerboseLogging

public boolean isVerboseLogging()

If verbose logging is required.

Returns:

true for verbose logging

getPullPolicy

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

If images should be pulled from a remote repository during image build.

Returns:

the pull policy

getPublish

public java.lang.Boolean getPublish()

If the built image should be pushed to a registry.

Returns:

true if the image should be published