com.google.cloud.tools.jib.api

Class DockerDaemonImage

java.lang.Object

com.google.cloud.tools.jib.api.DockerDaemonImage

public class DockerDaemonImage
extends Object

Builds to the Docker daemon.

Method Summary

Modifier and Type	Method and Description
static DockerDaemonImage	named(ImageReference imageReference) Instantiate with the image reference to tag the built image with.
static DockerDaemonImage	named(String imageReference) Instantiate with the image reference to tag the built image with.
DockerDaemonImage	setDockerEnvironment(Map<String,String> dockerEnvironment) Sets the additional environment variables to use when running docker.
DockerDaemonImage	setDockerExecutable(Path dockerExecutable) Sets the path to the docker CLI.

Methods inherited from class java.lang.Object

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

Method Detail

named

public static DockerDaemonImage named(ImageReference imageReference)

Instantiate with the image reference to tag the built image with. This is the name that shows up on the Docker daemon.

Parameters:

imageReference - the image reference

Returns:

a new DockerDaemonImage

named

public static DockerDaemonImage named(String imageReference)
                               throws InvalidImageReferenceException

Instantiate with the image reference to tag the built image with. This is the name that shows up on the Docker daemon.

Parameters:

imageReference - the image reference

Returns:

a new DockerDaemonImage

Throws:

InvalidImageReferenceException - if imageReference is not a valid image reference

setDockerExecutable

public DockerDaemonImage setDockerExecutable(Path dockerExecutable)

Sets the path to the docker CLI. This is docker by default.

Parameters:

dockerExecutable - the path to the docker CLI

Returns:

this

setDockerEnvironment

public DockerDaemonImage setDockerEnvironment(Map<String,String> dockerEnvironment)

Sets the additional environment variables to use when running docker.

Parameters:

dockerEnvironment - additional environment variables

Returns:

this