Skip navigation links
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
Adds a layer.
addAll(ImageLayers<U>) - Method in class com.google.cloud.tools.jib.image.ImageLayers
Adds all layers in layers.
addEntry(TarArchiveEntry) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
Adds an entry to the archive.
addEnvironmentVariableDefinition(String) - Method in class com.google.cloud.tools.jib.image.Image
Adds an environment variable definition in the format NAME=VALUE.
addError(ErrorEntryTemplate) - Method in class com.google.cloud.tools.jib.registry.json.ErrorResponseTemplate
 
addLayer(CacheMetadataLayerObjectTemplate) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataTemplate
 
addLayer(Layer) - Method in class com.google.cloud.tools.jib.image.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
 
addLayers(ImageLayers<T>) - Method in class com.google.cloud.tools.jib.image.Image
 
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

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.http.Request.Builder
 
build() - Method in class com.google.cloud.tools.jib.image.LayerBuilder
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
 
builder(BuildLogger) - Static method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
builder() - Static method in class com.google.cloud.tools.jib.http.Request
 
Builder() - Constructor for class com.google.cloud.tools.jib.http.Request.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
 
BuildImageMojo.ImageFormat - Enum in com.google.cloud.tools.jib.maven
Enumeration of BuildableManifestTemplates.
BuildImageSteps - Class in com.google.cloud.tools.jib.builder
All the steps to build an image.
BuildImageSteps(BuildConfiguration, SourceFilesConfiguration, Caches.Initializer) - Constructor for class com.google.cloud.tools.jib.builder.BuildImageSteps
 
BuildLogger - Interface in com.google.cloud.tools.jib.builder
 

C

Cache - Class in com.google.cloud.tools.jib.cache
Manages a cache.
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.
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
 
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.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.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.filesystem - package com.google.cloud.tools.jib.filesystem
 
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
 
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
 
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.
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
 
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
 

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.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.BuildImageMojo
 
execute() - Method in class com.google.cloud.tools.jib.maven.DockerContextMojo
 

F

filter(Predicate<? super Path>) - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker
Adds a filter to the walked paths.
forDockerHub(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAuthenticators
 
forOther(String, String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAuthenticators
 
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
 
from(List<String>, List<String>) - Static method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
Retrieves credentials for registries using the credential helpers referred to by credentialHelperSuffixes.
from(String, Map<String, Authorization>) - Static method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
Instantiates from a credential source and a map of registry credentials.
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

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
 
getApplicationCache() - Method in class com.google.cloud.tools.jib.cache.Caches
 
getAuthFor(String) - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate
 
getAuthorization(String) - Method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
 
getBaseCache() - Method in class com.google.cloud.tools.jib.cache.Caches
 
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
Gets the HTTP response body as a Blob.
getBuildConfiguration() - Method in class com.google.cloud.tools.jib.builder.BuildImageSteps
 
getBuildLogger() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getCacheDirectory() - Method in exception com.google.cloud.tools.jib.cache.CacheDirectoryNotOwnedException
 
getCachedLayer(DescriptorDigest, CountingOutputStream) - Method in class com.google.cloud.tools.jib.cache.CacheWriter
 
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
 
getCredentialHelperNames() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getCredentialSource(String) - 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
 
getEnableReproducibleBuilds() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
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
 
getFsLayers() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
 
getHash() - Method in class com.google.cloud.tools.jib.image.DescriptorDigest
 
getHeader(String) - Method in class com.google.cloud.tools.jib.http.Response
Gets a header in the response.
getHttpResponseException() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException
 
getImageReference() - Method in exception com.google.cloud.tools.jib.registry.RegistryUnauthorizedException
 
getJvmFlags() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getKnownRegistryCredentials() - 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
 
getLayerFile(List<Path>) - 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
Returns a read-only view of the image layers.
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
 
getMainClass() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
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.
getMessage() - Method in class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate
 
getProperties() - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate
 
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
 
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
 
getSourceFiles() - Method in class com.google.cloud.tools.jib.image.LayerBuilder
 
getStatusCode() - Method in class com.google.cloud.tools.jib.http.Response
Gets the HTTP status code of the response.
getTag() - Method in class com.google.cloud.tools.jib.image.ImageReference
 
getTargetFormat() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getTargetRegistry() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getTargetRepository() - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration
 
getTargetTag() - 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
 
getUpToDateLayerBySourceFiles(List<Path>) - 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
 
has(String) - Method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
 
hashCode() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
 
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
 

I

Image - Class in com.google.cloud.tools.jib.image
Represents an image.
Image() - Constructor for class com.google.cloud.tools.jib.image.Image
 
ImageLayers<T extends Layer> - Class in com.google.cloud.tools.jib.image
Holds the layers for an image.
ImageLayers() - Constructor for class com.google.cloud.tools.jib.image.ImageLayers
 
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) - Constructor for class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator
Instantiate with an Image that should not be modified afterwards.
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
 
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
 
isEmpty() - Method in class com.google.cloud.tools.jib.image.ImageLayers
 
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

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.
LayerBuilder - Class in com.google.cloud.tools.jib.image
Builds an UnwrittenLayer from files.
LayerBuilder(List<Path>, String, boolean) - Constructor for class com.google.cloud.tools.jib.image.LayerBuilder
 
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
 
LayerPropertyNotFoundException - Exception in com.google.cloud.tools.jib.image
Exception thrown when accessing non-existent properties of layers.

M

makeEntrypoint(SourceFilesConfiguration, List<String>, String) - Static method in class com.google.cloud.tools.jib.builder.EntrypointBuilder
Builds the container entrypoint.
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

newInitializer(Path) - Static method in class com.google.cloud.tools.jib.cache.Caches
 
none() - Static method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
Instantiates with no credentials.
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
Builds an image reference from a registry, repository, and tag.
of(String, String, Authorization) - Static method in class com.google.cloud.tools.jib.registry.credentials.RegistryCredentials
Instantiates with credentials for a single registry.

P

parse(String) - Static method in class com.google.cloud.tools.jib.image.ImageReference
Parses an image reference.
PathConsumer - Interface in com.google.cloud.tools.jib.filesystem
 
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.
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.
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 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(Authorization, String, String) - Constructor for class com.google.cloud.tools.jib.registry.RegistryClient
 
RegistryCredentials - Class in com.google.cloud.tools.jib.registry.credentials
Stores retrieved registry credentials.
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.
Request - Class in com.google.cloud.tools.jib.http
Holds an HTTP request.
Request.Builder - Class in com.google.cloud.tools.jib.http
 
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
Retrieves the Docker credentials by calling the corresponding CLI.
retrySupported() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent
 
run() - Method in class com.google.cloud.tools.jib.builder.BuildImageSteps
 

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.
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.
setBaseCacheDirectory(Path) - Method in class com.google.cloud.tools.jib.cache.Caches.Initializer
 
setBaseImage(ImageReference) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder
 
setBody(BlobHttpContent) - Method in class com.google.cloud.tools.jib.http.Request.Builder
Sets the body and its corresponding Content-Type header.
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
 
setCredentialHelperNames(List<String>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder
 
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
 
setEnableReproducibleBuilds(boolean) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder
 
setEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.image.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
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
 
setJvmFlags(List<String>) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder
 
setKnownRegistryCredentials(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
 
setMainClass(String) - Method in class com.google.cloud.tools.jib.builder.BuildConfiguration.Builder
 
setProperties(CacheMetadataLayerPropertiesObjectTemplate) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate
 
setSize(long) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerObjectTemplate
 
setSourceFiles(List<String>) - Method in class com.google.cloud.tools.jib.cache.json.CacheMetadataLayerPropertiesObjectTemplate
 
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
 
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.
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.
subTimer(String) - Method in class com.google.cloud.tools.jib.Timer
 

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() - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
Builds a Blob that can stream the uncompressed tarball archive BLOB.
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
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
 

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.

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.maven.BuildImageMojo.ImageFormat
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.cloud.tools.jib.maven.BuildImageMojo.ImageFormat
Returns an array containing the constants of this enum type, in the order they are declared.

W

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 and returns the walked files.
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
Creates an Authorization with a Basic credentials.
withBasicToken(String) - Static method in class com.google.cloud.tools.jib.http.Authorizations
Creates an Authorization with a base64-encoded username:password string.
withBearerToken(String) - Static method in class com.google.cloud.tools.jib.http.Authorizations
Creates an Authorization with a Bearer token.
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(LayerBuilder) - Method in class com.google.cloud.tools.jib.cache.CacheWriter
Builds an UnwrittenLayer from a LayerBuilder 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 
Skip navigation links

Copyright © 2018. All rights reserved.