com.google.cloud.tools.jib.api

Class TarImage

java.lang.Object

com.google.cloud.tools.jib.api.TarImage

public class TarImage
extends Object

Builds to a tarball archive.

Usage example:

 TarImage tarImage = TarImage.named("myimage")
                             .saveTo(Paths.get("image.tar"));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TarImage.Builder Finishes constructing a TarImage.

Method Summary

Modifier and Type	Method and Description
static TarImage.Builder	named(ImageReference imageReference) Configures the output tarball archive with an image reference.
static TarImage.Builder	named(String imageReference) Configures the output tarball archive with an image reference to set as its tag.

Methods inherited from class java.lang.Object

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

Method Detail

named

public static TarImage.Builder named(ImageReference imageReference)

Configures the output tarball archive with an image reference. This image reference will be the name of the image if loaded into the Docker daemon.

Parameters:

imageReference - the image reference

Returns:

a TarImage.Builder to finish constructing a new TarImage

named

public static TarImage.Builder named(String imageReference)
                              throws InvalidImageReferenceException

Configures the output tarball archive with an image reference to set as its tag.

Parameters:

imageReference - the image reference

Returns:

a TarImage.Builder to finish constructing a new TarImage

Throws:

InvalidImageReferenceException - if imageReference is not a valid image reference