com.google.cloud.tools.jib.builder

Class BuildSteps

java.lang.Object

com.google.cloud.tools.jib.builder.BuildSteps

public class BuildSteps
extends java.lang.Object

Steps for building an image.

Method Summary

Modifier and Type	Method and Description
static BuildSteps	forBuildToDockerDaemon(DockerClient dockerClient, BuildConfiguration buildConfiguration) All the steps to build to Docker daemon
static BuildSteps	forBuildToDockerRegistry(BuildConfiguration buildConfiguration) All the steps to build an image to a Docker registry.
static BuildSteps	forBuildToTar(java.nio.file.Path outputPath, BuildConfiguration buildConfiguration) All the steps to build an image tarball.
BuildConfiguration	getBuildConfiguration()
BuildResult	run() Executes the build.

Methods inherited from class java.lang.Object

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

Method Detail

forBuildToDockerRegistry

public static BuildSteps forBuildToDockerRegistry(BuildConfiguration buildConfiguration)

All the steps to build an image to a Docker registry.

Parameters:

buildConfiguration - the configuration parameters for the build

Returns:

a new BuildSteps for building to a registry

forBuildToDockerDaemon

public static BuildSteps forBuildToDockerDaemon(DockerClient dockerClient,
                                                BuildConfiguration buildConfiguration)

All the steps to build to Docker daemon

Parameters:

dockerClient - the DockerClient for running docker commands

buildConfiguration - the configuration parameters for the build

Returns:

a new BuildSteps for building to a Docker daemon

forBuildToTar

public static BuildSteps forBuildToTar(java.nio.file.Path outputPath,
                                       BuildConfiguration buildConfiguration)

All the steps to build an image tarball.

Parameters:

outputPath - the path to output the tarball to

buildConfiguration - the configuration parameters for the build

Returns:

a new BuildSteps for building a tarball

getBuildConfiguration

public BuildConfiguration getBuildConfiguration()

run

public BuildResult run()
                throws java.lang.InterruptedException,
                       java.util.concurrent.ExecutionException

Executes the build.

Returns:

the build result

Throws:

java.lang.InterruptedException - if the execution is interrupted

java.util.concurrent.ExecutionException - if an exception occurs during execution