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 Object

Builds the immutable Image.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Image.Builder<T>	addEnvironment(Map<String,String> environment) Adds a map of environment variables to the current map.
Image.Builder<T>	addEnvironmentVariable(String name, String value) Adds an environment variable with a given name and value.
Image.Builder<T>	addHistory(HistoryEntry history) Adds a history element to the image.
Image.Builder<T>	addLabel(String name, String value) Adds an item to the "Labels" field in the container configuration.
Image.Builder<T>	addLabels(Map<String,String> labels) Adds items to the "Labels" field in the container configuration.
Image.Builder<T>	addLayer(T layer) Adds a layer to the image.
Image<T>	build()
Image.Builder<T>	setCreated(Instant created) Sets the image creation time.
Image.Builder<T>	setEntrypoint(List<String> entrypoint) Sets the entrypoint of the image.
Image.Builder<T>	setExposedPorts(List<Port> exposedPorts) Sets the items in the "ExposedPorts" field in the container configuration.
Image.Builder<T>	setProgramArguments(List<String> programArguments) Sets the items in the "Cmd" field in the container configuration.
Image.Builder<T>	setUser(String user) Sets the user/group to run the container as.
Image.Builder<T>	setWorkingDirectory(String workingDirectory) Sets the item in the "WorkingDir" field in the container configuration.

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(Instant created)

Sets the image creation time.

Parameters:

created - the creation time

Returns:

this

addEnvironment

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

Adds a map of environment variables to the current map.

Parameters:

environment - the map of environment variables

Returns:

this

addEnvironmentVariable

public Image.Builder<T> addEnvironmentVariable(String name,
                                               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
                                      List<String> entrypoint)

Sets the entrypoint of the image.

Parameters:

entrypoint - the list of entrypoint tokens

Returns:

this

setUser

public Image.Builder<T> setUser(@Nullable
                                String user)

Sets the user/group to run the container as.

Parameters:

user - the username/UID and optionally the groupname/GID

Returns:

this

setProgramArguments

public Image.Builder<T> setProgramArguments(@Nullable
                                            List<String> programArguments)

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

Parameters:

programArguments - the list of arguments to append to the image entrypoint

Returns:

this

setExposedPorts

public Image.Builder<T> setExposedPorts(@Nullable
                                        List<Port> exposedPorts)

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

Parameters:

exposedPorts - the list of exposed ports to add

Returns:

this

addLabels

public Image.Builder<T> addLabels(@Nullable
                                  Map<String,String> labels)

Adds items to the "Labels" field in the container configuration.

Parameters:

labels - the map of labels to add

Returns:

this

addLabel

public Image.Builder<T> addLabel(String name,
                                 String value)

Adds an item to the "Labels" field in the container configuration.

Parameters:

name - the name of the label

value - the value of the label

Returns:

this

setWorkingDirectory

public Image.Builder<T> setWorkingDirectory(@Nullable
                                            String workingDirectory)

Sets the item in the "WorkingDir" field in the container configuration.

Parameters:

workingDirectory - the working directory

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

addHistory

public Image.Builder<T> addHistory(HistoryEntry history)

Adds a history element to the image.

Parameters:

history - the history object to add

Returns:

this

build

public Image<T> build()