com.google.cloud.tools.jib.image

Class Image.Builder<T extends Layer>

java.lang.Object

com.google.cloud.tools.jib.image.Image.Builder<T>

Enclosing class:

Image<T extends Layer>

public static class Image.Builder<T extends Layer>
extends java.lang.Object

Builds the immutable Image.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Image.Builder<T>	addEnvironment(java.util.Map<java.lang.String,java.lang.String> environment) Adds a map of environment variables to the current map.
Image.Builder<T>	addLayer(T layer) Adds a layer to the image.
Image<T>	build()
Image.Builder<T>	setCreated(java.time.Instant created) Sets the image creation time.
Image.Builder<T>	setEntrypoint(java.util.List<java.lang.String> entrypoint) Sets the entrypoint of the image.
Image.Builder<T>	setEnvironmentVariable(java.lang.String name, java.lang.String value) Adds an environment variable with a given name and value.
Image.Builder<T>	setExposedPorts(com.google.common.collect.ImmutableList<Port> exposedPorts) Sets the items in the "ExposedPorts" field in the container configuration.
Image.Builder<T>	setJavaArguments(java.util.List<java.lang.String> javaArguments) Sets the items in the "Cmd" field in the container configuration (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setCreated

public Image.Builder<T> setCreated(java.time.Instant created)

Sets the image creation time.

Parameters:

created - the creation time

Returns:

this

addEnvironment

public Image.Builder<T> addEnvironment(@Nullable
                                       java.util.Map<java.lang.String,java.lang.String> environment)

Adds a map of environment variables to the current map.

Parameters:

environment - the map of environment variables

Returns:

this

setEnvironmentVariable

public Image.Builder<T> setEnvironmentVariable(java.lang.String name,
                                               java.lang.String value)

Adds an environment variable with a given name and value.

Parameters:

name - the name of the variable

value - the value to set it to

Returns:

this

setEntrypoint

public Image.Builder<T> setEntrypoint(@Nullable
                                      java.util.List<java.lang.String> entrypoint)

Sets the entrypoint of the image.

Parameters:

entrypoint - the list of entrypoint tokens

Returns:

this

setJavaArguments

public Image.Builder<T> setJavaArguments(@Nullable
                                         java.util.List<java.lang.String> javaArguments)

Sets the items in the "Cmd" field in the container configuration (i.e. the main args).

Parameters:

javaArguments - the list of main args to add

Returns:

this

setExposedPorts

public Image.Builder<T> setExposedPorts(@Nullable
                                        com.google.common.collect.ImmutableList<Port> exposedPorts)

Sets the items in the "ExposedPorts" field in the container configuration.

Parameters:

exposedPorts - the list of exposed ports to add

Returns:

this

addLayer

public Image.Builder<T> addLayer(T layer)
                          throws LayerPropertyNotFoundException

Adds a layer to the image.

Parameters:

layer - the layer to add

Returns:

this

Throws:

LayerPropertyNotFoundException - if adding the layer fails

build

public Image<T> build()