com.google.cloud.tools.jib.cache

Class Cache

java.lang.Object

com.google.cloud.tools.jib.cache.Cache

@Immutable
public class Cache
extends Object

Cache for storing data to be shared between Jib executions.

This class is immutable and safe to use across threads.

Method Summary

Modifier and Type	Method and Description
Optional<CachedLayer>	retrieve(DescriptorDigest layerDigest) Retrieves the CachedLayer for the layer with digest layerDigest.
Optional<CachedLayer>	retrieve(com.google.common.collect.ImmutableList<LayerEntry> layerEntries) Retrieves the CachedLayer that was built from the layerEntries.
Optional<ManifestAndConfig>	retrieveMetadata(ImageReference imageReference) Retrieves the cached manifest and container configuration for an image reference.
static Cache	withDirectory(Path cacheDirectory) Initializes the cache using cacheDirectory for storage.
CachedLayer	writeCompressedLayer(Blob compressedLayerBlob) Saves a cache entry with a compressed layer Blob.
void	writeMetadata(ImageReference imageReference, BuildableManifestTemplate manifestTemplate, ContainerConfigurationTemplate containerConfigurationTemplate) Saves a manifest and container configuration for a V2.2 or OCI image.
void	writeMetadata(ImageReference imageReference, V21ManifestTemplate manifestTemplate) Saves a V2.1 image manifest.
CachedLayer	writeUncompressedLayer(Blob uncompressedLayerBlob, com.google.common.collect.ImmutableList<LayerEntry> layerEntries) Saves a cache entry with an uncompressed layer Blob and an additional selector digest.

Methods inherited from class java.lang.Object

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

Method Detail

withDirectory

public static Cache withDirectory(Path cacheDirectory)
                           throws IOException

Initializes the cache using cacheDirectory for storage.

Parameters:

cacheDirectory - the directory for the cache. Creates the directory if it does not exist.

Returns:

a new Cache

Throws:

IOException - if an I/O exception occurs

writeMetadata

public void writeMetadata(ImageReference imageReference,
                          BuildableManifestTemplate manifestTemplate,
                          ContainerConfigurationTemplate containerConfigurationTemplate)
                   throws IOException

Saves a manifest and container configuration for a V2.2 or OCI image.

Parameters:

imageReference - the image reference to save the manifest and container configuration for

manifestTemplate - the V2.2 or OCI manifest

containerConfigurationTemplate - the container configuration

Throws:

IOException - if an I/O exception occurs

writeMetadata

public void writeMetadata(ImageReference imageReference,
                          V21ManifestTemplate manifestTemplate)
                   throws IOException

Saves a V2.1 image manifest.

Parameters:

imageReference - the image reference to save the manifest and container configuration for

manifestTemplate - the V2.1 manifest

Throws:

IOException - if an I/O exception occurs

writeCompressedLayer

public CachedLayer writeCompressedLayer(Blob compressedLayerBlob)
                                 throws IOException

Saves a cache entry with a compressed layer Blob. Use writeUncompressedLayer(Blob, ImmutableList) to save a cache entry with an uncompressed layer Blob and include a selector.

Parameters:

compressedLayerBlob - the compressed layer Blob

Returns:

the CachedLayer for the written layer

Throws:

IOException - if an I/O exception occurs

writeUncompressedLayer

public CachedLayer writeUncompressedLayer(Blob uncompressedLayerBlob,
                                          com.google.common.collect.ImmutableList<LayerEntry> layerEntries)
                                   throws IOException

Saves a cache entry with an uncompressed layer Blob and an additional selector digest. Use writeCompressedLayer(Blob) to save a compressed layer Blob.

Parameters:

uncompressedLayerBlob - the layer Blob

layerEntries - the layer entries that make up the layer

Returns:

the CachedLayer for the written layer

Throws:

IOException - if an I/O exception occurs

retrieveMetadata

public Optional<ManifestAndConfig> retrieveMetadata(ImageReference imageReference)
                                             throws IOException,
                                                    CacheCorruptedException

Retrieves the cached manifest and container configuration for an image reference.

Parameters:

imageReference - the image reference

Returns:

the manifest and container configuration for the image reference, if found

Throws:

IOException - if an I/O exception occurs

CacheCorruptedException - if the cache is corrupted

retrieve

public Optional<CachedLayer> retrieve(com.google.common.collect.ImmutableList<LayerEntry> layerEntries)
                               throws IOException,
                                      CacheCorruptedException

Retrieves the CachedLayer that was built from the layerEntries.

Parameters:

layerEntries - the layer entries to match against

Returns:

a CachedLayer that was built from layerEntries, if found

Throws:

IOException - if an I/O exception occurs

CacheCorruptedException - if the cache is corrupted

retrieve

public Optional<CachedLayer> retrieve(DescriptorDigest layerDigest)
                               throws IOException,
                                      CacheCorruptedException

Retrieves the CachedLayer for the layer with digest layerDigest.

Parameters:

layerDigest - the layer digest

Returns:

the CachedLayer referenced by the layer digest, if found

Throws:

CacheCorruptedException - if the cache was found to be corrupted

IOException - if an I/O exception occurs