A B C D E F G H I J L M N O P R S T U V W

A

accept(Path) - Method in interface com.google.cloud.tools.jib.filesystem.PathConsumer

add(T) - Method in class com.google.cloud.tools.jib.image.ImageLayers.Builder

Adds a layer.

addAll(ImageLayers<U>) - Method in class com.google.cloud.tools.jib.image.ImageLayers.Builder

Adds all layers in layers.

addCachedLayersToMetadata(List<CachedLayer>) - Method in class com.google.cloud.tools.jib.cache.Cache

Adds the cached layer to the cache metadata.

addCachedLayersWithMetadataToMetadata(List<CachedLayerWithMetadata>) - Method in class com.google.cloud.tools.jib.cache.Cache

Adds the cached layer to the cache metadata.

addEntry(List<Path>, String) - Method in class com.google.cloud.tools.jib.configuration.LayerConfiguration.Builder

Adds an entry to the layer.

addEntry(TarArchiveEntry) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder

Adds an entry to the archive.

addEntry(String, String) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder

Adds a blob to the archive.

addEnvironmentVariableDefinition(String) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Adds an environment variable definition in the format NAME=VALUE.

addError(ErrorEntryTemplate) - Method in class com.google.cloud.tools.jib.registry.json.ErrorResponseTemplate

addFiles(List<Path>, String) - Method in class com.google.cloud.tools.jib.image.ReproducibleLayerBuilder

Adds the sourceFiles to be extracted on the image at extractionPath.

addLayer(CacheMetadataLayerObjectTemplate) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataTemplate

addLayer(T) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Adds a layer to the image.

addLayer(long, DescriptorDigest) - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate

Adds a layer to the manifest.

addLayer(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

addLayer(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

addLayerDiffId(DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

addLayerFile(String) - Method in class com.google.cloud.tools.jib.docker.json.DockerLoadManifestTemplate

AsyncStep<T> - Interface in com.google.cloud.tools.jib.async

Holds the future for an asynchronously-running step.

AsyncSteps - Class in com.google.cloud.tools.jib.async

Static methods for AsyncStep.

authenticatePull() - Method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator

Authenticates permissions to pull.

authenticatePush() - Method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator

Authenticates permission to pull and push.

Authorization - Class in com.google.cloud.tools.jib.http

Holds the credentials for an HTTP Authorization header.

Authorizations - Class in com.google.cloud.tools.jib.http

Static initializers for Authorization.

B

BadContainerConfigurationFormatException - Exception in com.google.cloud.tools.jib.image.json

Exception thrown when trying to parse a bad image configuration format.

Blob - Interface in com.google.cloud.tools.jib.blob

Holds a BLOB source for writing to an OutputStream.

BlobDescriptor - Class in com.google.cloud.tools.jib.blob

Contains properties describing a BLOB, including its digest and possibly its size (in bytes).

BlobDescriptor(long, DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.blob.BlobDescriptor

BlobDescriptor(DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.blob.BlobDescriptor

Initialize with just digest.

BlobHttpContent - Class in com.google.cloud.tools.jib.http

Blob-backed HttpContent.

BlobHttpContent(Blob, String) - Constructor for class com.google.cloud.tools.jib.http.BlobHttpContent

Blobs - Class in com.google.cloud.tools.jib.blob

Static methods for Blob.

BlobWriter - Interface in com.google.cloud.tools.jib.blob

This function writes the contents of a BLOB.

build() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

build() - Method in class com.google.cloud.tools.jib.configuration.LayerConfiguration.Builder

Returns the built LayerConfiguration.

build(HelpfulSuggestions) - Method in class com.google.cloud.tools.jib.frontend.BuildStepsRunner

Runs the BuildSteps.

build() - Method in class com.google.cloud.tools.jib.http.Request.Builder

build() - Method in class com.google.cloud.tools.jib.image.Image.Builder

build() - Method in class com.google.cloud.tools.jib.image.ImageLayers.Builder

build() - Method in class com.google.cloud.tools.jib.image.ReproducibleLayerBuilder

Builds and returns the layer.

BuildableManifestTemplate - Interface in com.google.cloud.tools.jib.image.json

Parent class for image manifest JSON templates that can be built.

BuildableManifestTemplate.ContentDescriptorTemplate - Class in com.google.cloud.tools.jib.image.json

Template for inner JSON object representing content descriptor for a layer or container configuration.

BuildConfiguration - Class in com.google.cloud.tools.jib.builder

Immutable configuration options for the builder process.

BuildConfiguration.Builder - Class in com.google.cloud.tools.jib.builder

BuildDockerMojo - Class in com.google.cloud.tools.jib.maven

Builds a container image and exports to the default Docker daemon.

BuildDockerMojo() - Constructor for class com.google.cloud.tools.jib.maven.BuildDockerMojo

builder(BuildLogger) - Static method in class com.google.cloud.tools.jib.builder.BuildConfiguration

builder() - Static method in class com.google.cloud.tools.jib.configuration.LayerConfiguration

builder() - Static method in class com.google.cloud.tools.jib.http.Request

Builder() - Constructor for class com.google.cloud.tools.jib.http.Request.Builder

builder() - Static method in class com.google.cloud.tools.jib.image.Image

Builder() - Constructor for class com.google.cloud.tools.jib.image.Image.Builder

builder() - Static method in class com.google.cloud.tools.jib.image.ImageLayers

Builder() - Constructor for class com.google.cloud.tools.jib.image.ImageLayers.Builder

BuildImageMojo - Class in com.google.cloud.tools.jib.maven

Builds a container image.

BuildImageMojo() - Constructor for class com.google.cloud.tools.jib.maven.BuildImageMojo

BuildLogger - Interface in com.google.cloud.tools.jib.builder

BuildSteps - Class in com.google.cloud.tools.jib.builder

Steps for building an image.

BuildStepsExecutionException - Exception in com.google.cloud.tools.jib.frontend

Wraps an exception that happens during BuildSteps.run().

BuildStepsRunner - Class in com.google.cloud.tools.jib.frontend

Runs a BuildSteps and builds helpful error messages.

C

Cache - Class in com.google.cloud.tools.jib.cache

Manages a cache.

CACHE_DIRECTORY_NAME - Static variable in interface com.google.cloud.tools.jib.frontend.ProjectProperties

Directory name for the cache.

CacheConfiguration - Class in com.google.cloud.tools.jib.configuration

Represents the location of the cache.

CacheDirectoryCreationException - Exception in com.google.cloud.tools.jib.cache

Thrown when a directory to be used as the Cache could not be created.

CacheDirectoryCreationException(Throwable) - Constructor for exception com.google.cloud.tools.jib.cache.CacheDirectoryCreationException

CacheDirectoryNotOwnedException - Exception in com.google.cloud.tools.jib.cache

Thrown when trying to use a directory as Cache, but the directory might be used by other applications.

CachedLayer - Class in com.google.cloud.tools.jib.cache

A Layer that has been written out to a cache and has its file-backed content BLOB, digest, size, and diff ID.

CachedLayer(Path, BlobDescriptor, DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.cache.CachedLayer

Initializes the layer with its file-backed content BLOB, content descriptor (digest and size), and diff ID.

CachedLayerWithMetadata - Class in com.google.cloud.tools.jib.cache

A CachedLayer with a last modified time.

CachedLayerWithMetadata(CachedLayer, LayerMetadata) - Constructor for class com.google.cloud.tools.jib.cache.CachedLayerWithMetadata

CacheMetadataCorruptedException - Exception in com.google.cloud.tools.jib.cache

Exception thrown when the cache metadata failed to load correctly, indicating that it is probably corrupted.

CacheMetadataCorruptedException(String) - Constructor for exception com.google.cloud.tools.jib.cache.CacheMetadataCorruptedException

CacheMetadataLayerObjectTemplate - Class in com.google.cloud.tools.jib.cache.json

Inner JSON template for storing metadata about a layer in the cache as part of CacheMetadataTemplate.

CacheMetadataLayerObjectTemplate() - Constructor for class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

CacheMetadataLayerPropertiesObjectTemplate - Class in com.google.cloud.tools.jib.cache.json

Inner JSON template for extra properties for an application layer, as part of CacheMetadataLayerObjectTemplate.

CacheMetadataLayerPropertiesObjectTemplate() - Constructor for class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate

CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate - Class in com.google.cloud.tools.jib.cache.json

Represents a pair of source files and extraction path.

CacheMetadataTemplate - Class in com.google.cloud.tools.jib.cache.json

JSON template for storing metadata about the cache.

CacheMetadataTemplate() - Constructor for class com.google.cloud.tools.jib.cache.json.CacheMetadataTemplate

CacheMetadataTranslator - Class in com.google.cloud.tools.jib.cache

Translates CacheMetadata to and from CacheMetadataTemplate.

CacheMetadataTranslator() - Constructor for class com.google.cloud.tools.jib.cache.CacheMetadataTranslator

CacheReader - Class in com.google.cloud.tools.jib.cache

Reads image content from the cache.

CacheReader(Cache) - Constructor for class com.google.cloud.tools.jib.cache.CacheReader

Caches - Class in com.google.cloud.tools.jib.cache

Manages both the base image layers cache and the application image layers cache.

Caches.Initializer - Class in com.google.cloud.tools.jib.cache

Initializes a Caches with directory paths.

CacheWriter - Class in com.google.cloud.tools.jib.cache

Writes UnwrittenLayers to the cache.

CacheWriter(Cache) - Constructor for class com.google.cloud.tools.jib.cache.CacheWriter

checkBlob(DescriptorDigest) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

close() - Method in class com.google.cloud.tools.jib.cache.Cache

Finishes the use of the cache by flushing any unsaved changes.

close() - Method in class com.google.cloud.tools.jib.cache.Caches

close() - Method in class com.google.cloud.tools.jib.http.Connection

close() - Method in class com.google.cloud.tools.jib.Timer

com.google.cloud.tools.jib - package com.google.cloud.tools.jib

com.google.cloud.tools.jib.async - package com.google.cloud.tools.jib.async

com.google.cloud.tools.jib.blob - package com.google.cloud.tools.jib.blob

com.google.cloud.tools.jib.builder - package com.google.cloud.tools.jib.builder

com.google.cloud.tools.jib.builder.steps - package com.google.cloud.tools.jib.builder.steps

com.google.cloud.tools.jib.cache - package com.google.cloud.tools.jib.cache

com.google.cloud.tools.jib.cache.json - package com.google.cloud.tools.jib.cache.json

com.google.cloud.tools.jib.configuration - package com.google.cloud.tools.jib.configuration

com.google.cloud.tools.jib.docker - package com.google.cloud.tools.jib.docker

com.google.cloud.tools.jib.docker.json - package com.google.cloud.tools.jib.docker.json

com.google.cloud.tools.jib.filesystem - package com.google.cloud.tools.jib.filesystem

com.google.cloud.tools.jib.frontend - package com.google.cloud.tools.jib.frontend

com.google.cloud.tools.jib.hash - package com.google.cloud.tools.jib.hash

com.google.cloud.tools.jib.http - package com.google.cloud.tools.jib.http

com.google.cloud.tools.jib.image - package com.google.cloud.tools.jib.image

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

com.google.cloud.tools.jib.json - package com.google.cloud.tools.jib.json

com.google.cloud.tools.jib.maven - package com.google.cloud.tools.jib.maven

com.google.cloud.tools.jib.registry - package com.google.cloud.tools.jib.registry

com.google.cloud.tools.jib.registry.credentials - package com.google.cloud.tools.jib.registry.credentials

com.google.cloud.tools.jib.registry.credentials.json - package com.google.cloud.tools.jib.registry.credentials.json

com.google.cloud.tools.jib.registry.json - package com.google.cloud.tools.jib.registry.json

com.google.cloud.tools.jib.tar - package com.google.cloud.tools.jib.tar

Connection - Class in com.google.cloud.tools.jib.http

Sends an HTTP Request and stores the Response.

Connection(URL) - Constructor for class com.google.cloud.tools.jib.http.Connection

Make sure to wrap with a try-with-resource to ensure that the connection is closed after usage.

ContainerConfigurationTemplate - Class in com.google.cloud.tools.jib.image.json

JSON Template for Docker Container Configuration referenced in Docker Manifest Schema V2.2

ContainerConfigurationTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

copy(ImmutableList<Path>, Path) - Static method in class com.google.cloud.tools.jib.filesystem.FileOperations

Copies sourceFiles to the destDir directory.

CountingDigestOutputStream - Class in com.google.cloud.tools.jib.hash

A DigestOutputStream that also keeps track of the total number of bytes written.

CountingDigestOutputStream(OutputStream) - Constructor for class com.google.cloud.tools.jib.hash.CountingDigestOutputStream

Wraps the outputStream.

D

debug(CharSequence) - Method in interface com.google.cloud.tools.jib.builder.BuildLogger

DEFAULT_CLASSES_PATH_ON_IMAGE - Static variable in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

DEFAULT_DEPENDENCIES_PATH_ON_IMAGE - Static variable in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

DEFAULT_RESOURCES_PATH_ON_IMAGE - Static variable in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

DescriptorDigest - Class in com.google.cloud.tools.jib.image

Represents a SHA-256 content descriptor digest as defined by the Registry HTTP API v2 reference.

DescriptorDigestDeserializer - Class in com.google.cloud.tools.jib.image.json

Deserializes a JSON element into a DescriptorDigest object.

DescriptorDigestDeserializer() - Constructor for class com.google.cloud.tools.jib.image.json.DescriptorDigestDeserializer

DescriptorDigestSerializer - Class in com.google.cloud.tools.jib.image.json

Serializes a DescriptorDigest into JSON element.

DescriptorDigestSerializer() - Constructor for class com.google.cloud.tools.jib.image.json.DescriptorDigestSerializer

deserialize(JsonParser, DeserializationContext) - Method in class com.google.cloud.tools.jib.image.json.DescriptorDigestDeserializer

DigestOnlyLayer - Class in com.google.cloud.tools.jib.image

A Layer reference that only has its DescriptorDigest.

DigestOnlyLayer(DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.image.DigestOnlyLayer

Instantiate with a DescriptorDigest.

DirectoryWalker - Class in com.google.cloud.tools.jib.filesystem

Recursively applies a function to each file in a directory.

DirectoryWalker(Path) - Constructor for class com.google.cloud.tools.jib.filesystem.DirectoryWalker

Initialize with a root directory to walk.

DockerClient - Class in com.google.cloud.tools.jib.docker

Calls out to the docker CLI.

DockerClient() - Constructor for class com.google.cloud.tools.jib.docker.DockerClient

DockerConfigCredentialRetriever - Class in com.google.cloud.tools.jib.registry.credentials

Retrieves registry credentials from the Docker config.

DockerConfigCredentialRetriever(String) - Constructor for class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever

DockerConfigTemplate - Class in com.google.cloud.tools.jib.registry.credentials.json

Template for a Docker config file.

DockerConfigTemplate() - Constructor for class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate

DockerContextGenerator - Class in com.google.cloud.tools.jib.docker

Generates a Docker context that mimics how Jib builds the image.

DockerContextGenerator(SourceFilesConfiguration) - Constructor for class com.google.cloud.tools.jib.docker.DockerContextGenerator

DockerContextMojo - Class in com.google.cloud.tools.jib.maven

Exports to a Docker context.

DockerContextMojo() - Constructor for class com.google.cloud.tools.jib.maven.DockerContextMojo

DockerCredentialHelper - Class in com.google.cloud.tools.jib.registry.credentials

Retrieves Docker credentials with a Docker credential helper.

DockerCredentialHelperFactory - Class in com.google.cloud.tools.jib.registry.credentials

Factory class for constructing DockerCredentialHelper.

DockerCredentialHelperFactory(String) - Constructor for class com.google.cloud.tools.jib.registry.credentials.DockerCredentialHelperFactory

DockerLoadManifestTemplate - Class in com.google.cloud.tools.jib.docker.json

JSON Template for loadable Docker Manifest.

DockerLoadManifestTemplate() - Constructor for class com.google.cloud.tools.jib.docker.json.DockerLoadManifestTemplate

E

EntrypointBuilder - Class in com.google.cloud.tools.jib.builder

Builds an image entrypoint for the Java application.

equals(Object) - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

Two BlobDescriptor objects are equal if their digests are not null and equal, and sizes are non-negative and equal

equals(Object) - Method in class com.google.cloud.tools.jib.configuration.Port

equals(Object) - Method in class com.google.cloud.tools.jib.image.DescriptorDigest

Two digest objects are equal if their digest strings are equal.

error(CharSequence) - Method in interface com.google.cloud.tools.jib.builder.BuildLogger

ErrorEntryTemplate - Class in com.google.cloud.tools.jib.registry.json

ErrorEntryTemplate(String, String) - Constructor for class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate

ErrorResponseTemplate - Class in com.google.cloud.tools.jib.registry.json

Template for the registry response body JSON when a request errored.

ErrorResponseTemplate() - Constructor for class com.google.cloud.tools.jib.registry.json.ErrorResponseTemplate

execute() - Method in class com.google.cloud.tools.jib.maven.BuildDockerMojo

execute() - Method in class com.google.cloud.tools.jib.maven.BuildImageMojo

execute() - Method in class com.google.cloud.tools.jib.maven.DockerContextMojo

ExposedPortsParser - Class in com.google.cloud.tools.jib.frontend

Utility for parsing exposed ports from plugin configuration

F

factory(String, String) - Static method in class com.google.cloud.tools.jib.registry.RegistryClient

FileOperations - Class in com.google.cloud.tools.jib.filesystem

Static methods for operating on the filesystem.

filter(Predicate<Path>) - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker

Adds a filter to the walked paths.

filterRoot() - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker

Filters away the rootDir.

forBuildImage(BuildConfiguration, SourceFilesConfiguration) - Static method in class com.google.cloud.tools.jib.frontend.BuildStepsRunner

Creates a runner to build an image.

forBuildToDockerDaemon(BuildConfiguration, SourceFilesConfiguration, Caches.Initializer) - Static method in class com.google.cloud.tools.jib.builder.BuildSteps

All the steps to build to Docker daemon

forBuildToDockerDaemon(BuildConfiguration, SourceFilesConfiguration) - Static method in class com.google.cloud.tools.jib.frontend.BuildStepsRunner

Creates a runner to build to the Docker daemon.

forBuildToDockerRegistry(BuildConfiguration, SourceFilesConfiguration, Caches.Initializer) - Static method in class com.google.cloud.tools.jib.builder.BuildSteps

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

forCacheDirectoryNotOwned(Path) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forCacheNeedsClean() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forCredentialsNotCorrect(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forDefaultUserLevelCacheDirectory() - Static method in class com.google.cloud.tools.jib.configuration.CacheConfiguration

The cache is at the default user-level cache directory.

forDockerContextInsecureRecursiveDelete(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forDockerHub(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAuthenticators

forDockerNotInstalled() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forHttpHostConnect() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forHttpStatusCodeForbidden(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forInsecureRegistry() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forMainClassNotFound(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forNoCredentialHelpersDefinedForBaseImage(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forNoCredentialHelpersDefinedForTargetImage(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forOther(String, String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAuthenticators

Gets a RegistryAuthenticator for a custom registry server and repository.

forPath(Path) - Static method in class com.google.cloud.tools.jib.configuration.CacheConfiguration

The cache is at an arbitrary path.

forToNotConfigured(String, String, String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

forUnknownHost() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

from(InputStream) - Static method in class com.google.cloud.tools.jib.blob.Blobs

from(Path) - Static method in class com.google.cloud.tools.jib.blob.Blobs

from(String) - Static method in class com.google.cloud.tools.jib.blob.Blobs

from(BlobWriter) - Static method in class com.google.cloud.tools.jib.blob.Blobs

fromDigest(String) - Static method in class com.google.cloud.tools.jib.image.DescriptorDigest

Creates a new instance from a valid digest string.

fromHash(String) - Static method in class com.google.cloud.tools.jib.image.DescriptorDigest

Creates a new instance from a valid hash string.

G

generate(Path) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Creates the Docker context in #targetDirectory.

get(AsyncStep<T>) - Static method in class com.google.cloud.tools.jib.async.NonBlockingSteps

get(Request) - Method in class com.google.cloud.tools.jib.http.Connection

Sends the request with method GET.

get(int) - Method in class com.google.cloud.tools.jib.image.ImageLayers

get(DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.ImageLayers

getAllowHttp() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

Gets whether or not to allow communication over HTTP (as opposed to HTTPS).

getApplicationCache() - Method in class com.google.cloud.tools.jib.cache.Caches

getApplicationLayersCacheConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

Gets the location of the cache for storing application layers.

getAuthFor(String) - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate

getAuthorization() - Method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials

getBaseCache() - Method in class com.google.cloud.tools.jib.cache.Caches

getBaseImageCredentialHelperName() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getBaseImageLayersCacheConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

Gets the location of the cache for storing base image layers.

getBaseImageReference() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getBaseImageRegistry() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getBaseImageRepository() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getBaseImageTag() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getBlob() - Method in class com.google.cloud.tools.jib.cache.CachedLayer

getBlob() - Method in class com.google.cloud.tools.jib.image.DigestOnlyLayer

getBlob() - Method in interface com.google.cloud.tools.jib.image.Layer

getBlob() - Method in class com.google.cloud.tools.jib.image.ReferenceLayer

getBlob() - Method in class com.google.cloud.tools.jib.image.ReferenceNoDiffIdLayer

getBlob() - Method in class com.google.cloud.tools.jib.image.UnwrittenLayer

Gets the uncompressed layer content BLOB.

getBlobDescriptor() - Method in class com.google.cloud.tools.jib.cache.CachedLayer

getBlobDescriptor() - Method in class com.google.cloud.tools.jib.image.DigestOnlyLayer

getBlobDescriptor() - Method in interface com.google.cloud.tools.jib.image.Layer

getBlobDescriptor() - Method in class com.google.cloud.tools.jib.image.ReferenceLayer

getBlobDescriptor() - Method in class com.google.cloud.tools.jib.image.ReferenceNoDiffIdLayer

getBlobDescriptor() - Method in class com.google.cloud.tools.jib.image.UnwrittenLayer

getBody() - Method in class com.google.cloud.tools.jib.http.Response

getBuildConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildSteps

getBuildLogger() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getCachedApplicationLayers() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

getCachedBaseImageLayers() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

getCacheDirectory() - Method in exception com.google.cloud.tools.jib.cache.CacheDirectoryNotOwnedException

getCacheDirectory() - Method in class com.google.cloud.tools.jib.configuration.CacheConfiguration

Gets the path to the cache directory.

getCacheDirectory() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getCachedLayer(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.CacheWriter

Gets the layer that was cached by writing the contents to a file in the cache.

getCacheHome() - Static method in class com.google.cloud.tools.jib.filesystem.UserCacheHome

getClassesFiles() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getClassesPathOnImage() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getCode() - Method in class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate

getContainerConfiguration() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate

getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

getContainerConfigurationBlob() - Method in class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator

Gets the container configuration as a Blob.

getContentFile() - Method in class com.google.cloud.tools.jib.cache.CachedLayer

getContentLength() - Method in class com.google.cloud.tools.jib.http.Response

getCredentialHelperFor(String) - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate

getCredentialSource() - Method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials

getDependenciesFiles() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getDependenciesPathOnImage() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getDiffId() - Method in class com.google.cloud.tools.jib.cache.CachedLayer

getDiffId() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

getDiffId() - Method in class com.google.cloud.tools.jib.image.DigestOnlyLayer

getDiffId() - Method in interface com.google.cloud.tools.jib.image.Layer

getDiffId() - Method in class com.google.cloud.tools.jib.image.ReferenceLayer

getDiffId() - Method in class com.google.cloud.tools.jib.image.ReferenceNoDiffIdLayer

getDiffId() - Method in class com.google.cloud.tools.jib.image.UnwrittenLayer

getDigest() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

getDigest() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

getDigest() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate

getEntrypoint() - Method in class com.google.cloud.tools.jib.image.Image

getEnvironment() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getEnvironment() - Method in class com.google.cloud.tools.jib.image.Image

getErrors() - Method in class com.google.cloud.tools.jib.registry.json.ErrorResponseTemplate

getExposedPorts() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getExposedPorts() - Method in class com.google.cloud.tools.jib.image.Image

getExtractionPath() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate

getExtractionPath() - Method in class com.google.cloud.tools.jib.image.LayerEntry

getExtraFilesLayerConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

Gets the LayerConfiguration for an extra layer.

getFromString(String) - Static method in enum com.google.cloud.tools.jib.configuration.Port.Protocol

Returns the Port.Protocol given its string representation.

getFsLayers() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate

getFuture() - Method in interface com.google.cloud.tools.jib.async.AsyncStep

getHash() - Method in class com.google.cloud.tools.jib.image.DescriptorDigest

getHeader(String) - Method in class com.google.cloud.tools.jib.http.Response

getHttpResponseException() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException

getImageReference() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException

getJarPluginName() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getJavaArguments() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getJavaArguments() - Method in class com.google.cloud.tools.jib.image.Image

getJvmFlags() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getKnownBaseRegistryCredentials() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getKnownTargetRegistryCredentials() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getLastModifiedTime() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate

getLayer(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.CacheReader

getLayerDigests() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate

getLayerEntries() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate

getLayerEntries() - Method in class com.google.cloud.tools.jib.configuration.LayerConfiguration

getLayerEntries() - Method in class com.google.cloud.tools.jib.image.ReproducibleLayerBuilder

getLayerFile(ImmutableList<LayerEntry>) - Method in class com.google.cloud.tools.jib.cache.CacheReader

Finds the file that stores the content BLOB for an application layer.

getLayerOutputStream(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.CacheWriter

getLayers() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataTemplate

getLayers() - Method in class com.google.cloud.tools.jib.image.Image

getLayers() - Method in class com.google.cloud.tools.jib.image.ImageLayers

getLayers() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate

getLayers() - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

getLayers() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

getLength() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent

getList() - Method in class com.google.cloud.tools.jib.docker.json.DockerLoadManifestTemplate

getList() - Method in interface com.google.cloud.tools.jib.json.ListOfJsonTemplate

getLogger() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getMainClass() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getMainClassFromJar() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getMainClassHelpfulSuggestions(String) - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getManifestMediaType() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate

getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

getManifestTemplate(Class<T>, BlobDescriptor) - Method in class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator

Gets the manifest as a JSON template.

getManifestTemplateClass() - Method in enum com.google.cloud.tools.jib.image.ImageFormat

getMessage() - Method in class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate

getPluginName() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getPort() - Method in class com.google.cloud.tools.jib.configuration.Port

getProperties() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

getProtocol() - Method in class com.google.cloud.tools.jib.configuration.Port

getRegistry() - Method in class com.google.cloud.tools.jib.image.ImageReference

getRegistry() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException

getRegistryAuthenticator() - Method in class com.google.cloud.tools.jib.registry.RegistryClient

getRepository() - Method in class com.google.cloud.tools.jib.image.ImageReference

getRepository() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException

getRequestUrl() - Method in class com.google.cloud.tools.jib.http.Response

getResourcesFiles() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getResourcesPathOnImage() - Method in interface com.google.cloud.tools.jib.builder.SourceFilesConfiguration

getSchemaVersion() - Method in interface com.google.cloud.tools.jib.image.json.ManifestTemplate

getSchemaVersion() - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

getSchemaVersion() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate

getSchemaVersion() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

getScheme() - Method in class com.google.cloud.tools.jib.http.Authorization

getSize() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

getSize() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

getSize() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate

getSourceFiles() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate

getSourceFiles() - Method in class com.google.cloud.tools.jib.image.LayerEntry

getSourceFilesConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildSteps

getSourceFilesConfiguration() - Method in interface com.google.cloud.tools.jib.frontend.ProjectProperties

getStartupMessage() - Method in class com.google.cloud.tools.jib.builder.BuildSteps

getStatusCode() - Method in class com.google.cloud.tools.jib.http.Response

getSuccessMessage() - Method in class com.google.cloud.tools.jib.builder.BuildSteps

getTag() - Method in class com.google.cloud.tools.jib.image.ImageReference

getTargetFormat() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getTargetImageCredentialHelperName() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getTargetImageReference() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getTargetImageRegistry() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getTargetImageRepository() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getTargetImageTag() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration

getToken() - Method in class com.google.cloud.tools.jib.http.Authorization

getTotalBytes() - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream

getType() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent

getUpToDateLayerByLayerEntries(ImmutableList<LayerEntry>) - Method in class com.google.cloud.tools.jib.cache.CacheReader

Gets an up-to-date layer that is built from the sourceFiles.

GITHUB_NEW_ISSUE_URL - Static variable in class com.google.cloud.tools.jib.ProjectInfo

Link to file an issue against the GitHub repository.

GITHUB_URL - Static variable in class com.google.cloud.tools.jib.ProjectInfo

Link to the GitHub repository.

H

has(DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.ImageLayers

hashCode() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

hashCode() - Method in class com.google.cloud.tools.jib.configuration.Port

hashCode() - Method in class com.google.cloud.tools.jib.image.DescriptorDigest

Pass-through hash code of the digest string.

hasSize() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

HelpfulSuggestions - Class in com.google.cloud.tools.jib.frontend

Builds messages that provides suggestions on how to fix the error.

HelpfulSuggestions(String, String, String, Function<String, String>, String, Function<String, String>) - Constructor for class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

Creates a new HelpfulSuggestions with frontend-specific texts.

I

Image<T extends Layer> - Class in com.google.cloud.tools.jib.image

Represents an image.

Image.Builder<T extends Layer> - Class in com.google.cloud.tools.jib.image

Builds the immutable Image.

ImageFormat - Enum in com.google.cloud.tools.jib.image

Enumeration of BuildableManifestTemplates.

ImageLayers<T extends Layer> - Class in com.google.cloud.tools.jib.image

Holds the layers for an image.

ImageLayers.Builder<T extends Layer> - Class in com.google.cloud.tools.jib.image

ImageReference - Class in com.google.cloud.tools.jib.image

Represents an image reference.

ImageToJsonTranslator - Class in com.google.cloud.tools.jib.image.json

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

ImageToJsonTranslator(Image<CachedLayer>) - Constructor for class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator

Instantiate with an Image.

ImageToTarballTranslator - Class in com.google.cloud.tools.jib.docker

Translates an Image to a tarball that can be loaded into Docker.

ImageToTarballTranslator(Image<CachedLayer>) - Constructor for class com.google.cloud.tools.jib.docker.ImageToTarballTranslator

Instantiate with an Image.

immediate(T) - Static method in class com.google.cloud.tools.jib.async.AsyncSteps

info(CharSequence) - Method in interface com.google.cloud.tools.jib.builder.BuildLogger

init(Path) - Static method in class com.google.cloud.tools.jib.cache.Cache

Initializes a cache with a directory.

init() - Method in class com.google.cloud.tools.jib.cache.Caches.Initializer

Initializer(Path, boolean, Path, boolean) - Constructor for class com.google.cloud.tools.jib.cache.Caches.Initializer

InsecureRegistryException - Exception in com.google.cloud.tools.jib.registry

Throw when attempting to access an insecure registry when only secure connections are allowed.

InvalidImageReferenceException - Exception in com.google.cloud.tools.jib.image

Thrown when attempting to parse an invalid image reference.

InvalidImageReferenceException(String) - Constructor for exception com.google.cloud.tools.jib.image.InvalidImageReferenceException

isDockerInstalled() - Method in class com.google.cloud.tools.jib.docker.DockerClient

isEmpty() - Method in class com.google.cloud.tools.jib.image.ImageLayers

isValidJavaClass(String) - Static method in class com.google.cloud.tools.jib.builder.BuildConfiguration

isValidRegistry(String) - Static method in class com.google.cloud.tools.jib.image.ImageReference

isValidRepository(String) - Static method in class com.google.cloud.tools.jib.image.ImageReference

isValidTag(String) - Static method in class com.google.cloud.tools.jib.image.ImageReference

iterator() - Method in class com.google.cloud.tools.jib.image.ImageLayers

J

JsonTemplate - Interface in com.google.cloud.tools.jib.json

All JSON templates to be used with JsonTemplateMapper must extend this class.

JsonTemplateMapper - Class in com.google.cloud.tools.jib.json

Helper class for serializing and deserializing JSON.

JsonToImageTranslator - Class in com.google.cloud.tools.jib.image.json

Translates V21ManifestTemplate and V22ManifestTemplate into Image.

L

lap(String) - Method in class com.google.cloud.tools.jib.Timer

Layer - Interface in com.google.cloud.tools.jib.image

Represents a layer in an image.

LayerConfiguration - Class in com.google.cloud.tools.jib.configuration

Configures how to build a layer in the container image.

LayerConfiguration.Builder - Class in com.google.cloud.tools.jib.configuration

Builds a LayerConfiguration.

LayerCountMismatchException - Exception in com.google.cloud.tools.jib.image

Exception thrown when the number of layers found did not match expectations.

LayerCountMismatchException(String) - Constructor for exception com.google.cloud.tools.jib.image.LayerCountMismatchException

LayerEntry - Class in com.google.cloud.tools.jib.image

Represents an entry in the layer.

LayerEntry(ImmutableList<Path>, String) - Constructor for class com.google.cloud.tools.jib.image.LayerEntry

LayerEntryTemplate(List<String>, String) - Constructor for class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate

LayerEntryTemplate() - Constructor for class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate

LayerPropertyNotFoundException - Exception in com.google.cloud.tools.jib.image

Exception thrown when accessing non-existent properties of layers.

lifecycle(CharSequence) - Method in interface com.google.cloud.tools.jib.builder.BuildLogger

Logs messages as part of normal execution (default log level).

ListOfJsonTemplate - Interface in com.google.cloud.tools.jib.json

All JSON templates to be used with JsonTemplateMapper that need to be wrapped in a list must extend this class.

load(Blob) - Method in class com.google.cloud.tools.jib.docker.DockerClient

Loads an image tarball into the Docker daemon.

M

MainClassFinder - Class in com.google.cloud.tools.jib.frontend

Infers the main class in an application.

MainClassInferenceException - Exception in com.google.cloud.tools.jib.frontend

Thrown when main class inference fails.

makeEntrypoint(SourceFilesConfiguration, List<String>, String) - Static method in class com.google.cloud.tools.jib.builder.EntrypointBuilder

Builds the container entrypoint.

makeTemporary() - Static method in class com.google.cloud.tools.jib.configuration.CacheConfiguration

The cache is a temporary directory that is deleted afterwards.

MANIFEST_MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

The OCI manifest media type.

MANIFEST_MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

The Docker V2.2 manifest media type.

ManifestTemplate - Interface in com.google.cloud.tools.jib.image.json

Parent class for image manifest JSON templates.

MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate

N

newRegistryClient() - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory

Creates a new RegistryClient.

NonBlockingSteps - Class in com.google.cloud.tools.jib.async

Static utility for ensuring Future.get() does not block.

none() - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

NonexistentDockerCredentialHelperException - Exception in com.google.cloud.tools.jib.registry.credentials

Thrown because the requested credential helper CLI does not exist.

NonexistentServerUrlDockerCredentialHelperException - Exception in com.google.cloud.tools.jib.registry.credentials

Thrown because the credential helper does not have credentials for the specified server URL.

O

OCIManifestTemplate - Class in com.google.cloud.tools.jib.image.json

JSON Template for OCI Manifest Schema

OCIManifestTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

of(String, String, String) - Static method in class com.google.cloud.tools.jib.image.ImageReference

P

parse(List<String>) - Static method in class com.google.cloud.tools.jib.frontend.ExposedPortsParser

Converts/validates a list of strings representing port ranges to an expanded list of Ports.

parse(String) - Static method in class com.google.cloud.tools.jib.image.ImageReference

PathConsumer - Interface in com.google.cloud.tools.jib.filesystem

Port - Class in com.google.cloud.tools.jib.configuration

Holds port number and protocol for an exposed port.

Port(int, Port.Protocol) - Constructor for class com.google.cloud.tools.jib.configuration.Port

Port.Protocol - Enum in com.google.cloud.tools.jib.configuration

Represents the protocol portion of the port.

post(Request) - Method in class com.google.cloud.tools.jib.http.Connection

Sends the request with method POST.

ProjectInfo - Class in com.google.cloud.tools.jib

Constants relating to the Jib project.

ProjectProperties - Interface in com.google.cloud.tools.jib.frontend

Project property methods that require maven/gradle-specific implementations.

pullBlob(DescriptorDigest, OutputStream) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Downloads the BLOB to a file.

pullManifest(String, Class<T>) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Pulls the image manifest for a specific tag.

pullManifest(String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

pushBlob(DescriptorDigest, Blob) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Pushes the BLOB, or skips if the BLOB already exists on the registry.

pushManifest(BuildableManifestTemplate, String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Pushes the image manifest for a specific tag.

put(Request) - Method in class com.google.cloud.tools.jib.http.Connection

Sends the request with method PUT.

R

readJson(String, Class<T>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Deserializes a JSON object from a JSON string.

readJsonFromFile(Path, Class<T>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Deserializes a JSON file via a JSON object template.

readListOfJson(String, Class<T>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Deserializes a JSON object list from a JSON string.

ReferenceLayer - Class in com.google.cloud.tools.jib.image

A Layer reference that does not have the underlying content.

ReferenceLayer(BlobDescriptor, DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.image.ReferenceLayer

Instantiate with a BlobDescriptor and diff ID.

ReferenceNoDiffIdLayer - Class in com.google.cloud.tools.jib.image

A Layer reference that does not have the underlying content.

ReferenceNoDiffIdLayer(BlobDescriptor) - Constructor for class com.google.cloud.tools.jib.image.ReferenceNoDiffIdLayer

Instantiate with a BlobDescriptor and no diff ID.

RegistryAuthenticationFailedException - Exception in com.google.cloud.tools.jib.registry

Thrown because registry authentication failed.

RegistryAuthenticator - Class in com.google.cloud.tools.jib.registry

Authenticates push/pull access with a registry service.

RegistryAuthenticators - Class in com.google.cloud.tools.jib.registry

Static initializers for RegistryAuthenticator.

RegistryAuthenticators() - Constructor for class com.google.cloud.tools.jib.registry.RegistryAuthenticators

RegistryClient - Class in com.google.cloud.tools.jib.registry

Interfaces with a registry.

RegistryClient.Factory - Class in com.google.cloud.tools.jib.registry

Factory for creating RegistryClients.

RegistryCredentials - Class in com.google.cloud.tools.jib.registry.credentials

Stores retrieved registry credentials and their source.

RegistryCredentials(String, Authorization) - Constructor for class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials

RegistryErrorException - Exception in com.google.cloud.tools.jib.registry

Thrown when an HTTP request to a registry endpoint failed with errors as defined in ErrorCodes.

RegistryException - Exception in com.google.cloud.tools.jib.registry

Thrown when interacting with a registry.

RegistryException(String, Throwable) - Constructor for exception com.google.cloud.tools.jib.registry.RegistryException

RegistryException(String) - Constructor for exception com.google.cloud.tools.jib.registry.RegistryException

RegistryException(Throwable) - Constructor for exception com.google.cloud.tools.jib.registry.RegistryException

RegistryNoResponseException - Exception in com.google.cloud.tools.jib.registry

Thrown when a registry did not respond.

RegistryUnauthorizedException - Exception in com.google.cloud.tools.jib.registry

Thrown when a registry request was unauthorized and therefore authentication is needed.

RegistryUnauthorizedException(String, String, HttpResponseException) - Constructor for exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException

Identifies the image registry and repository that denied access.

ReproducibleLayerBuilder - Class in com.google.cloud.tools.jib.image

Builds a reproducible UnwrittenLayer from files.

ReproducibleLayerBuilder() - Constructor for class com.google.cloud.tools.jib.image.ReproducibleLayerBuilder

Request - Class in com.google.cloud.tools.jib.http

Holds an HTTP request.

Request.Builder - Class in com.google.cloud.tools.jib.http

resolveMainClass(String, ProjectProperties) - Static method in class com.google.cloud.tools.jib.frontend.MainClassFinder

If mainClass is null, tries to infer main class in this order: 1.

Response - Class in com.google.cloud.tools.jib.http

Holds an HTTP response.

retrieve() - Method in class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever

retrieve() - Method in class com.google.cloud.tools.jib.registry.credentials.DockerCredentialHelper

retrySupported() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent

run() - Method in class com.google.cloud.tools.jib.builder.BuildSteps

runAuthenticatePushStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runBuildAndCacheApplicationLayerSteps() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runBuildImageStep(ImmutableList<String>) - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runFinalizingBuildStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runFinalizingPushStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runLoadDockerStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPullAndCacheBaseImageLayersStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPullBaseImageStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPushApplicationLayersStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPushBaseImageLayersStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPushContainerConfigurationStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runPushImageStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

runRetrieveTargetRegistryCredentialsStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

S

send(String, Request) - Method in class com.google.cloud.tools.jib.http.Connection

Sends the request.

serialize(DescriptorDigest, JsonGenerator, SerializerProvider) - Method in class com.google.cloud.tools.jib.image.json.DescriptorDigestSerializer

setAccept(List<String>) - Method in class com.google.cloud.tools.jib.http.Request.Builder

Sets the Accept header.

setAllowHttp(boolean) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

Sets whether or not to allow communication over HTTP (as opposed to HTTPS).

setAllowHttp(boolean) - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory

Sets whether or not HTTP should be allowed (credentials should not be sent when set to true).

setApplicationLayersCacheConfiguration(CacheConfiguration) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

Sets the location of the cache for storing application layers.

setAuthorization(Authorization) - Method in class com.google.cloud.tools.jib.http.Request.Builder

Sets the Authorization header.

setAuthorization(Authorization) - Method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator

Sets an Authorization header to authenticate with.

setAuthorization(Authorization) - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory

Sets the authentication credentials to use to authenticate with the registry.

setBaseImage(ImageReference) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setBaseImage(String) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Sets the base image for the FROM directive.

setBaseImageCredentialHelperName(String) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setBaseImageLayersCacheConfiguration(CacheConfiguration) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

Sets the location of the cache for storing base image layers.

setBody(BlobHttpContent) - Method in class com.google.cloud.tools.jib.http.Request.Builder

Sets the body and its corresponding Content-Type header.

setContainerCmd(List<String>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setContainerConfiguration(long, DescriptorDigest) - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate

Sets the content descriptor of the container configuration.

setContainerConfiguration(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.OCIManifestTemplate

setContainerConfiguration(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

setContainerEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setContainerEnvironment(List<String>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setContainerExposedPorts(Map<String, Map<?, ?>>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setDiffId(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

setDigest(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

setEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Sets the entrypoint of the image.

setEnvironment(Map<String, String>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setEnvironment(Map<String, String>) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Sets the environment with a map from environment variable names to values.

setEnvironmentVariable(String, String) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Adds an environment variable with a given name and value.

setExposedPorts(List<Port>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setExposedPorts(List<String>) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Sets the exposed ports.

setExposedPorts(ImmutableList<Port>) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Sets the items in the "ExposedPorts" field in the container configuration.

setExtraFilesLayerConfiguration(LayerConfiguration) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

Sets the LayerConfiguration for an extra layer.

setJavaArguments(List<String>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setJavaArguments(List<String>) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Sets the arguments used in the CMD.

setJavaArguments(List<String>) - Method in class com.google.cloud.tools.jib.image.Image.Builder

Sets the items in the "Cmd" field in the container configuration (i.e.

setJvmFlags(List<String>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setJvmFlags(List<String>) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Sets the JVM flags used in the ENTRYPOINT.

setKnownBaseRegistryCredentials(RegistryCredentials) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setKnownTargetRegistryCredentials(RegistryCredentials) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setLastModifiedTime(FileTime) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate

setLayerEntries(List<CacheMetadataLayerPropertiesObjectTemplate.LayerEntryTemplate>) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate

setMainClass(String) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setMainClass(String) - Method in class com.google.cloud.tools.jib.docker.DockerContextGenerator

Sets the main class used in the ENTRYPOINT.

setProperties(CacheMetadataLayerPropertiesObjectTemplate) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

setRepoTags(String) - Method in class com.google.cloud.tools.jib.docker.json.DockerLoadManifestTemplate

setSize(long) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate

setTargetFormat(Class<? extends BuildableManifestTemplate>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setTargetImage(ImageReference) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setTargetImageCredentialHelperName(String) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder

setTimer(Timer) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

setUserAgent(String) - Method in class com.google.cloud.tools.jib.http.Request.Builder

Sets the User-Agent header.

setUserAgentSuffix(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryClient

Sets a suffix to append to User-Agent headers.

shouldEnsureOwnership() - Method in class com.google.cloud.tools.jib.configuration.CacheConfiguration

Gets whether or not the cache directory should be checked for write safety.

size() - Method in class com.google.cloud.tools.jib.image.ImageLayers

SourceFilesConfiguration - Interface in com.google.cloud.tools.jib.builder

Immutable configuration that defines where the source files for each of the application layers are.

StepsRunner - Class in com.google.cloud.tools.jib.builder.steps

Runs steps for building an image.

StepsRunner(BuildConfiguration, SourceFilesConfiguration, Cache, Cache) - Constructor for class com.google.cloud.tools.jib.builder.steps.StepsRunner

subTimer(String) - Method in class com.google.cloud.tools.jib.Timer

suggest(String) - Method in class com.google.cloud.tools.jib.frontend.HelpfulSuggestions

T

TarStreamBuilder - Class in com.google.cloud.tools.jib.tar

Builds a tarball archive.

TarStreamBuilder() - Constructor for class com.google.cloud.tools.jib.tar.TarStreamBuilder

Timer - Class in com.google.cloud.tools.jib

Times execution intervals.

Timer(BuildLogger, String) - Constructor for class com.google.cloud.tools.jib.Timer

toBlob(JsonTemplate) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Convert a JsonTemplate to a Blob of the JSON string.

toBlob(ListOfJsonTemplate) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Convert a ListOfJsonTemplate to a Blob of the JSON string.

toBlob() - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder

toBlobDescriptor() - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream

Builds a BlobDescriptor with the hash and size of the bytes written.

toImage(V21ManifestTemplate) - Static method in class com.google.cloud.tools.jib.image.json.JsonToImageTranslator

Translates V21ManifestTemplate to Image.

toImage(BuildableManifestTemplate, ContainerConfigurationTemplate) - Static method in class com.google.cloud.tools.jib.image.json.JsonToImageTranslator

Translates BuildableManifestTemplate to Image.

toString() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor

toString() - Method in enum com.google.cloud.tools.jib.configuration.Port.Protocol

toString() - Method in class com.google.cloud.tools.jib.configuration.Port

toString() - Method in class com.google.cloud.tools.jib.http.Authorization

Return the HTTP Authorization header value.

toString() - Method in class com.google.cloud.tools.jib.image.DescriptorDigest

toString() - Method in class com.google.cloud.tools.jib.image.ImageReference

toStringWithTag() - Method in class com.google.cloud.tools.jib.image.ImageReference

toTarballBlob(ImageReference) - Method in class com.google.cloud.tools.jib.docker.ImageToTarballTranslator

U

UnexpectedBlobDigestException - Exception in com.google.cloud.tools.jib.registry

Thrown when a pulled BLOB did not have the same digest as requested.

UnknownManifestFormatException - Exception in com.google.cloud.tools.jib.image.json

Exception thrown when trying to parse an unknown image manifest format.

UnknownManifestFormatException(String) - Constructor for exception com.google.cloud.tools.jib.image.json.UnknownManifestFormatException

UnwrittenLayer - Class in com.google.cloud.tools.jib.image

A layer that has not been written out and only has the unwritten content Blob.

UnwrittenLayer(Blob) - Constructor for class com.google.cloud.tools.jib.image.UnwrittenLayer

Initializes with the uncompressed Blob of the layer content.

UserCacheHome - Class in com.google.cloud.tools.jib.filesystem

Obtains an OS-specific user cache directory based on the XDG Base Directory Specification.

usesDefaultTag() - Method in class com.google.cloud.tools.jib.image.ImageReference

V

V21ManifestTemplate - Class in com.google.cloud.tools.jib.image.json

JSON template for Docker Manifest Schema V2.1

V21ManifestTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.V21ManifestTemplate

V22ManifestTemplate - Class in com.google.cloud.tools.jib.image.json

JSON Template for Docker Manifest Schema V2.2

V22ManifestTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.V22ManifestTemplate

valueOf(String) - Static method in enum com.google.cloud.tools.jib.configuration.Port.Protocol

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.cloud.tools.jib.image.ImageFormat

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.cloud.tools.jib.configuration.Port.Protocol

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.cloud.tools.jib.image.ImageFormat

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitOnLoadDockerStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

waitOnPushImageStep() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner

walk(PathConsumer) - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker

Walks DirectoryWalker.rootDir and applies pathConsumer to each file.

walk() - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker

Walks DirectoryWalker.rootDir.

warn(CharSequence) - Method in interface com.google.cloud.tools.jib.builder.BuildLogger

withBasicCredentials(String, String) - Static method in class com.google.cloud.tools.jib.http.Authorizations

withBasicToken(String) - Static method in class com.google.cloud.tools.jib.http.Authorizations

withBearerToken(String) - Static method in class com.google.cloud.tools.jib.http.Authorizations

withCredentialHelperSuffix(String) - Method in class com.google.cloud.tools.jib.registry.credentials.DockerCredentialHelperFactory

write(byte[], int, int) - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream

write(int) - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream

writeLayer(ReproducibleLayerBuilder) - Method in class com.google.cloud.tools.jib.cache.CacheWriter

Builds an UnwrittenLayer from a ReproducibleLayerBuilder and compresses and writes the UnwrittenLayer's uncompressed layer content BLOB to cache.

writeTo(OutputStream) - Method in interface com.google.cloud.tools.jib.blob.Blob

Writes the BLOB to an OutputStream.

writeTo(OutputStream) - Method in interface com.google.cloud.tools.jib.blob.BlobWriter

writeTo(OutputStream) - Method in class com.google.cloud.tools.jib.http.BlobHttpContent

writeToByteArray(Blob) - Static method in class com.google.cloud.tools.jib.blob.Blobs

Writes the BLOB to a byte array.

writeToString(Blob) - Static method in class com.google.cloud.tools.jib.blob.Blobs

Writes the BLOB to a string.

A B C D E F G H I J L M N O P R S T U V W