com.google.cloud.tools.jib.image.json

Class ImageToJsonTranslator

java.lang.Object

com.google.cloud.tools.jib.image.json.ImageToJsonTranslator

public class ImageToJsonTranslator
extends Object

Translates an Image into a manifest or container configuration JSON BLOB.

Example usage:

 ImageToJsonTranslator translator = new ImageToJsonTranslator(image);
 Blob containerConfigurationBlob = translator.getContainerConfigurationBlob();
 BlobDescriptor containerConfigurationBlobDescriptor = blob.writeTo(outputStream);
 Blob manifestBlob = translator.getManifestBlob(containerConfigurationBlobDescriptor);
 

Constructor Summary

Constructors

Constructor and Description
ImageToJsonTranslator(Image<CachedLayer> image) Instantiate with an Image.

Method Summary

Modifier and Type	Method and Description
Blob	getContainerConfigurationBlob() Gets the container configuration as a Blob.
<T extends BuildableManifestTemplate> T	getManifestTemplate(Class<T> manifestTemplateClass, BlobDescriptor containerConfigurationBlobDescriptor) Gets the manifest as a JSON template.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageToJsonTranslator

public ImageToJsonTranslator(Image<CachedLayer> image)

Instantiate with an Image.

Parameters:

image - the image to translate.

Method Detail

getContainerConfigurationBlob

public Blob getContainerConfigurationBlob()

Gets the container configuration as a Blob.

Returns:

the container configuration Blob.

getManifestTemplate

public <T extends BuildableManifestTemplate> T getManifestTemplate(Class<T> manifestTemplateClass,
                                                                   BlobDescriptor containerConfigurationBlobDescriptor)

Gets the manifest as a JSON template. The containerConfigurationBlobDescriptor must be the [@link BlobDescriptor} obtained by writing out the container configuration Blob returned from getContainerConfigurationBlob().

Type Parameters:

T - child type of BuildableManifestTemplate.

Parameters:

manifestTemplateClass - the JSON template to translate the image to.

containerConfigurationBlobDescriptor - the container configuration descriptor.

Returns:

the image contents serialized as JSON.