com.google.cloud.tools.jib.configuration

Class BuildConfiguration.Builder

java.lang.Object

com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Enclosing class:

BuildConfiguration

public static class BuildConfiguration.Builder
extends Object

Builds an immutable BuildConfiguration. Instantiate with BuildConfiguration.builder().

Method Summary

Modifier and Type	Method and Description
BuildConfiguration	build() Builds a new BuildConfiguration using the parameters passed into the builder.
BuildConfiguration.Builder	setAdditionalTargetImageTags(Set<String> tags) Sets the tags to tag the target image with (in addition to the tag in the target image configuration image reference set via setTargetImageConfiguration(com.google.cloud.tools.jib.configuration.ImageConfiguration)).
BuildConfiguration.Builder	setAllowInsecureRegistries(boolean allowInsecureRegistries) Sets whether or not to allow communication over HTTP (as opposed to HTTPS).
BuildConfiguration.Builder	setApplicationLayersCacheDirectory(Path applicationLayersCacheDirectory) Sets the location of the cache for storing application layers.
BuildConfiguration.Builder	setBaseImageConfiguration(ImageConfiguration imageConfiguration) Sets the base image configuration.
BuildConfiguration.Builder	setBaseImageLayersCacheDirectory(Path baseImageLayersCacheDirectory) Sets the location of the cache for storing base image layers.
BuildConfiguration.Builder	setContainerConfiguration(ContainerConfiguration containerConfiguration) Sets configuration parameters for the container.
BuildConfiguration.Builder	setEventHandlers(EventHandlers eventHandlers) Sets the EventHandlers to dispatch events with.
BuildConfiguration.Builder	setExecutorService(ExecutorService executorService) Sets the ExecutorService Jib executes on.
BuildConfiguration.Builder	setLayerConfigurations(List<LayerConfiguration> layerConfigurations) Sets the layers to build.
BuildConfiguration.Builder	setOffline(boolean offline) Sets whether or not to perform the build in offline mode.
BuildConfiguration.Builder	setTargetFormat(ImageFormat targetFormat) Sets the target format of the container image.
BuildConfiguration.Builder	setTargetImageConfiguration(ImageConfiguration imageConfiguration) Sets the target image configuration.
BuildConfiguration.Builder	setToolName(String toolName) Sets the name of the tool that is executing the build.

Methods inherited from class java.lang.Object

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

Method Detail

setBaseImageConfiguration

public BuildConfiguration.Builder setBaseImageConfiguration(ImageConfiguration imageConfiguration)

Sets the base image configuration.

Parameters:

imageConfiguration - the ImageConfiguration describing the base image

Returns:

this

setTargetImageConfiguration

public BuildConfiguration.Builder setTargetImageConfiguration(ImageConfiguration imageConfiguration)

Sets the target image configuration.

Parameters:

imageConfiguration - the ImageConfiguration describing the target image

Returns:

this

setAdditionalTargetImageTags

public BuildConfiguration.Builder setAdditionalTargetImageTags(Set<String> tags)

Sets the tags to tag the target image with (in addition to the tag in the target image configuration image reference set via setTargetImageConfiguration(com.google.cloud.tools.jib.configuration.ImageConfiguration)).

Parameters:

tags - a set of tags

Returns:

this

setContainerConfiguration

public BuildConfiguration.Builder setContainerConfiguration(ContainerConfiguration containerConfiguration)

Sets configuration parameters for the container.

Parameters:

containerConfiguration - the ContainerConfiguration

Returns:

this

setApplicationLayersCacheDirectory

public BuildConfiguration.Builder setApplicationLayersCacheDirectory(Path applicationLayersCacheDirectory)

Sets the location of the cache for storing application layers.

Parameters:

applicationLayersCacheDirectory - the application layers cache directory

Returns:

this

setBaseImageLayersCacheDirectory

public BuildConfiguration.Builder setBaseImageLayersCacheDirectory(Path baseImageLayersCacheDirectory)

Sets the location of the cache for storing base image layers.

Parameters:

baseImageLayersCacheDirectory - the base image layers cache directory

Returns:

this

setTargetFormat

public BuildConfiguration.Builder setTargetFormat(ImageFormat targetFormat)

Sets the target format of the container image.

Parameters:

targetFormat - the target format

Returns:

this

setAllowInsecureRegistries

public BuildConfiguration.Builder setAllowInsecureRegistries(boolean allowInsecureRegistries)

Sets whether or not to allow communication over HTTP (as opposed to HTTPS).

Parameters:

allowInsecureRegistries - if true, insecure connections will be allowed

Returns:

this

setOffline

public BuildConfiguration.Builder setOffline(boolean offline)

Sets whether or not to perform the build in offline mode.

Parameters:

offline - if true, the build will run in offline mode

Returns:

this

setLayerConfigurations

public BuildConfiguration.Builder setLayerConfigurations(List<LayerConfiguration> layerConfigurations)

Sets the layers to build.

Parameters:

layerConfigurations - the configurations for the layers

Returns:

this

setToolName

public BuildConfiguration.Builder setToolName(String toolName)

Sets the name of the tool that is executing the build.

Parameters:

toolName - the tool name

Returns:

this

setEventHandlers

public BuildConfiguration.Builder setEventHandlers(EventHandlers eventHandlers)

Sets the EventHandlers to dispatch events with.

Parameters:

eventHandlers - the EventHandlers

Returns:

this

setExecutorService

public BuildConfiguration.Builder setExecutorService(ExecutorService executorService)

Sets the ExecutorService Jib executes on. By default, Jib uses Executors.newCachedThreadPool().

Parameters:

executorService - the ExecutorService

Returns:

this

build

public BuildConfiguration build()
                         throws IOException

Builds a new BuildConfiguration using the parameters passed into the builder.

Returns:

the corresponding build configuration

Throws:

IOException - if an I/O exception occurs