com.google.cloud.tools.jib.configuration

Class ContainerConfiguration.Builder

java.lang.Object

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

Enclosing class:

ContainerConfiguration

public static class ContainerConfiguration.Builder
extends java.lang.Object

Builder for instantiating a ContainerConfiguration.

Method Summary

Modifier and Type	Method and Description
void	addEnvironment(java.lang.String name, java.lang.String value)
void	addExposedPort(Port port)
void	addLabel(java.lang.String key, java.lang.String value)
void	addVolume(AbsoluteUnixPath volume)
ContainerConfiguration	build() Builds the ContainerConfiguration.
ContainerConfiguration.Builder	setCreationTime(java.time.Instant creationTime) Sets the image creation time.
ContainerConfiguration.Builder	setEntrypoint(java.util.List<java.lang.String> entrypoint) Sets the container entrypoint.
ContainerConfiguration.Builder	setEnvironment(java.util.Map<java.lang.String,java.lang.String> environmentMap) Sets the container's environment variables, mapping variable name to value.
ContainerConfiguration.Builder	setExposedPorts(java.util.Set<Port> exposedPorts) Sets the container's exposed ports.
ContainerConfiguration.Builder	setLabels(java.util.Map<java.lang.String,java.lang.String> labels) Sets the container's labels.
ContainerConfiguration.Builder	setProgramArguments(java.util.List<java.lang.String> programArguments) Sets the commandline arguments for main.
ContainerConfiguration.Builder	setUser(java.lang.String user) Sets the user and group to run the container as.
ContainerConfiguration.Builder	setVolumes(java.util.Set<AbsoluteUnixPath> volumes) Sets the container's volumes.
ContainerConfiguration.Builder	setWorkingDirectory(AbsoluteUnixPath workingDirectory) Sets the working directory in the container.

Methods inherited from class java.lang.Object

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

Method Detail

setCreationTime

public ContainerConfiguration.Builder setCreationTime(java.time.Instant creationTime)

Sets the image creation time.

Parameters:

creationTime - the creation time

Returns:

this

setProgramArguments

public ContainerConfiguration.Builder setProgramArguments(@Nullable
                                                          java.util.List<java.lang.String> programArguments)

Sets the commandline arguments for main.

Parameters:

programArguments - the list of arguments

Returns:

this

setEnvironment

public ContainerConfiguration.Builder setEnvironment(@Nullable
                                                     java.util.Map<java.lang.String,java.lang.String> environmentMap)

Sets the container's environment variables, mapping variable name to value.

Parameters:

environmentMap - the map

Returns:

this

addEnvironment

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

setExposedPorts

public ContainerConfiguration.Builder setExposedPorts(@Nullable
                                                      java.util.Set<Port> exposedPorts)

Sets the container's exposed ports.

Parameters:

exposedPorts - the set of ports

Returns:

this

addExposedPort

public void addExposedPort(Port port)

setVolumes

public ContainerConfiguration.Builder setVolumes(@Nullable
                                                 java.util.Set<AbsoluteUnixPath> volumes)

Sets the container's volumes.

Parameters:

volumes - the set of volumes

Returns:

this

addVolume

public void addVolume(AbsoluteUnixPath volume)

setLabels

public ContainerConfiguration.Builder setLabels(@Nullable
                                                java.util.Map<java.lang.String,java.lang.String> labels)

Sets the container's labels.

Parameters:

labels - the map of labels

Returns:

this

addLabel

public void addLabel(java.lang.String key,
                     java.lang.String value)

setEntrypoint

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

Sets the container entrypoint.

Parameters:

entrypoint - the tokenized command to run when the container starts

Returns:

this

setUser

public ContainerConfiguration.Builder setUser(@Nullable
                                              java.lang.String user)

Sets the user and group to run the container as. user can be a username or UID along with an optional groupname or GID. The following are all valid: user, uid, user:group, uid:gid, uid:group, user:gid.

Parameters:

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

Returns:

this

setWorkingDirectory

public ContainerConfiguration.Builder setWorkingDirectory(@Nullable
                                                          AbsoluteUnixPath workingDirectory)

Sets the working directory in the container.

Parameters:

workingDirectory - the working directory

Returns:

this

build

public ContainerConfiguration build()

Builds the ContainerConfiguration.

Returns:

the corresponding ContainerConfiguration