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

A

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

Represents a Unix-style path in absolute form (containing all path components relative to the file system root /).

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

add(JibEventType<E>, Consumer<E>) - Method in class com.google.cloud.tools.jib.event.EventHandlers

Adds the eventConsumer to handle the JibEvent with class eventClass.

add(Consumer<JibEvent>) - Method in class com.google.cloud.tools.jib.event.EventHandlers

Adds the eventConsumer to handle all JibEvent types.

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.

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

Adds a blob to the archive.

addByteEntry(byte[], String) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder

Adds a blob to the archive.

addClassFile(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Adds a file to the classes layer.

addCredential(String, String) - Method in class com.google.cloud.tools.jib.api.RegistryImage

Adds a username-password credential to use to push/pull the image.

addCredentialRetriever(CredentialRetriever) - Method in class com.google.cloud.tools.jib.api.RegistryImage

Adds CredentialRetriever to fetch push/pull credentials for the image.

addDependencyFile(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Adds a file to the dependency layer.

addEntry(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.configuration.LayerConfiguration.Builder

Adds an entry to the layer.

addEntryRecursive(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.configuration.LayerConfiguration.Builder

Adds an entry to the layer.

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

Adds a map of environment variables to the current map.

addEnvironmentVariable(String, String) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets a variable in the container environment.

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

Adds an environment variable with a given name and value.

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

addExposedPort(Port) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Adds a port to expose from the container.

addExtraFile(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Adds a file to the extra files layer.

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

Adds a history element to the image.

addHistoryEntry(HistoryEntry) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

addLabel(String, String) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets a label for the container.

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

Adds an item to the "Labels" field in the container configuration.

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

Adds items to the "Labels" field in the container configuration.

addLayer(List<Path>, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Adds a new layer to the container with files as the source files and pathInContainer as the path to copy the source files to in the container file system.

addLayer(LayerConfiguration) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Adds a layer (defined by a LayerConfiguration).

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.DockerLoadManifestEntryTemplate

addResourceFile(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Adds a file to the resource layer.

addSnapshotDependencyFile(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

Adds a file to the snapshot dependency layer.

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

Adds a TarArchiveEntry to the archive.

ALL - Static variable in class com.google.cloud.tools.jib.event.JibEventType

All event types.

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.

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

B

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

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

basic(String, String) - Static method in class com.google.cloud.tools.jib.configuration.credentials.Credential

Gets a Credential configured with a username and password.

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.configuration.BuildConfiguration.Builder

Builds a new BuildConfiguration using the parameters passed into the builder.

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

Builds the ContainerConfiguration.

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

Builds the ImageConfiguration.

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

Returns the built LayerConfiguration.

build() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations.Builder

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.json.HistoryEntry.Builder

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

Builds and returns the layer Blob.

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.configuration

Immutable configuration options for the builder process.

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

Builds an immutable BuildConfiguration.

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

Creates a new BuildConfiguration.Builder to build a BuildConfiguration.

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

Constructs a builder for a ContainerConfiguration.

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

Constructs a builder for an ImageConfiguration.

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

Gets a new LayerConfiguration.Builder for LayerConfiguration.

builder() - Static method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

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

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

Creates a builder for a HistoryEntry.

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

Steps for building an image.

C

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

Cache for storing data to be shared between Jib executions.

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

Thrown if the the cache was found to be corrupted.

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

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

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

CacheEntry - Interface in com.google.cloud.tools.jib.cache

Represents a cache entry for a layer stored in the cache.

call() - Method in class com.google.cloud.tools.jib.builder.steps.WriteTarFileStep

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

checkHttpTimeoutProperty() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties

Checks the jib.httpTimeout system property for invalid (non-integer or negative) values.

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

Laps and dispatches a TimerEvent.State.FINISHED TimerEvent upon close.

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

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

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

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

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.configuration - package com.google.cloud.tools.jib.configuration

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

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.event - package com.google.cloud.tools.jib.event

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

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.global - package com.google.cloud.tools.jib.global

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.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.

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

Immutable configuration options for the container.

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

Builder for instantiating a ContainerConfiguration.

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

containerize(Containerizer) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Builds the container(s).

Containerizer - Class in com.google.cloud.tools.jib.api

Configures how to containerize.

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.

Credential - Class in com.google.cloud.tools.jib.configuration.credentials

Holds credentials (username and password).

CREDENTIAL_HELPER_PREFIX - Static variable in class com.google.cloud.tools.jib.registry.credentials.DockerCredentialHelper

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

Thrown because the requested credential helper CLI does not exist.

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

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

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

Thrown if something went wrong during CredentialRetriever.retrieve().

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

CredentialRetriever - Interface in com.google.cloud.tools.jib.configuration.credentials

Retrieves credentials for a registry.

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

Static factories for various CredentialRetrievers.

D

debug(String) - Static method in class com.google.cloud.tools.jib.event.events.LogEvent

DEFAULT_APP_ROOT - Static variable in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

The default app root in the image.

DEFAULT_BASE_CACHE_DIRECTORY - Static variable in class com.google.cloud.tools.jib.api.Containerizer

The default directory for caching the base image layers, in [user cache home]/google-cloud-tools-java/jib.

DEFAULT_CREATION_TIME - Static variable in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

The default creation time of the container (constant to ensure reproducibility by default).

DEFAULT_RELATIVE_CLASSES_PATH_ON_IMAGE - Static variable in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

DEFAULT_RELATIVE_DEPENDENCIES_PATH_ON_IMAGE - Static variable in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

DEFAULT_RELATIVE_RESOURCES_PATH_ON_IMAGE - Static variable in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

DEFAULT_WEB_APP_ROOT - Static variable in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

The default webapp root in the image.

DefaultEventDispatcher - Class in com.google.cloud.tools.jib.event

Dispatches JibEvents to event handlers.

DefaultEventDispatcher(EventHandlers) - Constructor for class com.google.cloud.tools.jib.event.DefaultEventDispatcher

Creates an instance from Handlers in an EventHandlers.

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.

dispatch(JibEvent) - Method in class com.google.cloud.tools.jib.event.DefaultEventDispatcher

Dispatches jibEvent to all the handlers that can handle it.

dispatch(JibEvent) - Method in interface com.google.cloud.tools.jib.event.EventDispatcher

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

Calls out to the docker CLI.

dockerConfig() - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever that tries to retrieve credentials from Docker config (located at $USER_HOME/.docker/config.json).

dockerConfig(Path) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever that tries to retrieve credentials from a custom path to a Docker config.

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

DockerConfigCredentialRetriever(String, Path) - 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

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

Template for an auth defined for a registry under auths.

dockerCredentialHelper(String) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

dockerCredentialHelper(Path) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever for retrieving credentials via a Docker credential helper, such as docker-credential-gcr.

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

Retrieves Docker credentials with a Docker credential helper.

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

Constructs a new DockerCredentialHelper.

DockerDaemonImage - Class in com.google.cloud.tools.jib.api

Builds to the Docker daemon.

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

JSON Template for a loadable Docker Manifest entry.

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

E

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.ContainerConfiguration

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

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

equals(Object) - Method in class com.google.cloud.tools.jib.event.events.LogEvent

equals(Object) - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

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

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

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

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

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

error(String) - Static method in class com.google.cloud.tools.jib.event.events.LogEvent

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

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

Utility methods for parsing JSON-encoded error responses.

EventDispatcher - Interface in com.google.cloud.tools.jib.event

Dispatches JibEvents.

EventHandlers - Class in com.google.cloud.tools.jib.event

Builds a set of event handlers to handle JibEvents.

EventHandlers() - Constructor for class com.google.cloud.tools.jib.event.EventHandlers

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

Utility for parsing exposed ports from text representations.

F

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

Creates a new RegistryClient.Factory for building a 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.

find() - Method in class com.google.cloud.tools.jib.frontend.MainClassFinder

Tries to find classes with psvm (see class javadoc) in MainClassFinder.files.

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

All the steps to build to Docker daemon

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

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

forBuildToTar(Path, BuildConfiguration) - Static method in class com.google.cloud.tools.jib.builder.BuildSteps

All the steps to build an image tarball.

forImage(ImageReference, EventDispatcher) - Static method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetrieverFactory for an image.

forImage(ImageReference) - Static method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetrieverFactory for an image.

from(String) - Static method in class com.google.cloud.tools.jib.api.Jib

Starts building the container from a base image.

from(ImageReference) - Static method in class com.google.cloud.tools.jib.api.Jib

Starts building the container from a base image.

from(RegistryImage) - Static method in class com.google.cloud.tools.jib.api.Jib

Starts building the container from a base image.

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

Creates a StringBlob with UTF-8 encoding.

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.

fromPath(Path) - Static method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Gets a new AbsoluteUnixPath from a Path.

G

generate(Path) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Creates the Docker context in #targetDirectory.

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

Gets the completed computation result of asyncStep.

get(String) - Static method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Gets a new AbsoluteUnixPath from a Unix-style path string.

get(String) - Static method in class com.google.cloud.tools.jib.filesystem.RelativeUnixPath

Gets a new RelativeUnixPath from a Unix-style path in relative form.

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

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

Gets the extraction path as an absolute path in Unix form.

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

Get the source file as an absolute path in Unix form.

getAliasesGroup(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAliasGroup

Returns the list of registry aliases for the given registry, including registry as the first element.

getAllowInsecureRegistries() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Gets whether or not to allow insecure registries (ignoring certificate validation failure or communicating over HTTP if all else fail).

getAllTargetImageTags() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

getApplicationLayersCache() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Gets the Cache for application layers.

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

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

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

getBaseImageConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

getBaseImageLayersCache() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Gets the Cache for base image layers.

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

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

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

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

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

getClassLayerEntries() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

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

getConnectionFactory() - Static method in class com.google.cloud.tools.jib.http.Connection

Returns a factory for Connection.

getContainerConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

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.

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

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

getCreationTime() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

getCredentialRetrievers() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration

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

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

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

getDependencyLayerEntries() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

getDescription() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent

Gets the description associated with this event.

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

getDigest() - Method in class com.google.cloud.tools.jib.api.JibContainer

Gets the digest of the container image built by Jib.

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

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

getDirectory() - Method in class com.google.cloud.tools.jib.filesystem.TemporaryDirectory

Gets the temporary directory.

getDuration() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent

Gets the duration since the last TimerEvent for this timer.

getElapsed() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent

Gets the total elapsed duration since this timer was created.

getEntrypoint() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

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

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

getEnvironmentMap() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

getErrorCode(HttpResponseException) - Static method in class com.google.cloud.tools.jib.registry.ErrorResponseUtil

Extract an ErrorCodes response from the error object encoded in an HttpResponseException.

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

getEventDispatcher() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

getExecutorService() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

getExposedPorts() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

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

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

Gets the extraction path.

getExtraFilesLayerEntries() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

getFoundMainClass() - Method in class com.google.cloud.tools.jib.frontend.MainClassFinder.Result

Gets the found main class.

getFoundMainClasses() - Method in class com.google.cloud.tools.jib.frontend.MainClassFinder.Result

Gets the found main classes.

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

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

getFuture() - Method in class com.google.cloud.tools.jib.builder.steps.WriteTarFileStep

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

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

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

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

getHttpTimeout() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties

Gets the HTTP connection/read timeouts for registry interactions in milliseconds.

getImage() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration

getImageName() - Method in exception com.google.cloud.tools.jib.registry.RegistryAuthenticationFailedException

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

getImageRegistry() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration

getImageRepository() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration

getImageTag() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration

getInsecureConnectionFactory() - Static method in class com.google.cloud.tools.jib.http.Connection

Returns a factory for Connection that does not verify TLS peer verification.

getLabels() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

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

getLayerBlob() - Method in interface com.google.cloud.tools.jib.cache.CacheEntry

Gets the Blob for the layer.

getLayerConfigurations() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Gets the configurations for building the layers.

getLayerConfigurations() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

getLayerDiffId() - Method in interface com.google.cloud.tools.jib.cache.CacheEntry

Gets the diff ID of the layer.

getLayerDigest() - Method in interface com.google.cloud.tools.jib.cache.CacheEntry

Gets the digest of the layer.

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

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

Gets the list of layer entries.

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

getLayerSize() - Method in interface com.google.cloud.tools.jib.cache.CacheEntry

Gets the size of the layer, in bytes.

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

getLevel() - Method in class com.google.cloud.tools.jib.event.events.LogEvent

Gets the log level to log at.

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.event.events.LogEvent

Gets the log message.

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

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

Gets the name.

getParent() - Method in interface com.google.cloud.tools.jib.event.events.TimerEvent.Timer

Gets the parent of this TimerEvent.Timer.

getPassword() - Method in class com.google.cloud.tools.jib.configuration.credentials.Credential

Gets the password.

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

Gets the port number.

getProgramArguments() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

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

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

Gets the protocol.

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

Gets the registry portion of the 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

Gets the repository portion of the ImageReference.

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

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

getResourceLayerEntries() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

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

getServerUrl() - Method in exception com.google.cloud.tools.jib.registry.RegistryAuthenticationFailedException

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

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

getSnapshotDependencyLayerEntries() - Method in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

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

Gets the source file.

getState() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent

Gets the state of the timer.

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

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

Gets the tag portion of the ImageReference.

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

getTargetImageConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

getTimer() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent

Gets the timer this event is for.

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

getToolName() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

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

getType() - Method in class com.google.cloud.tools.jib.frontend.MainClassFinder.Result

Gets the type of the result.

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

getUser() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration

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

getUsername() - Method in class com.google.cloud.tools.jib.configuration.credentials.Credential

Gets the username.

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

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

hasCorrespondingLayer() - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry

Returns whether or not the history object corresponds to a layer in the container.

HASH_LENGTH - Static variable in class com.google.cloud.tools.jib.image.DescriptorDigest

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

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

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

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

hashCode() - Method in class com.google.cloud.tools.jib.event.events.LogEvent

hashCode() - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

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

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

Pass-through hash code of the digest string.

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

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

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

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

Represents an item in the container configuration's history list.

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

HistoryEntry.Builder - Class in com.google.cloud.tools.jib.image.json

HTTP_TIMEOUT - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties

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.

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

Immutable configuration options for an image reference with credentials.

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

Builder for instantiating an ImageConfiguration.

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

Enumeration of BuildableManifestTemplates that indicates the format of the image.

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<Layer>) - 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<Layer>) - 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

inferCredentialHelper() - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever that tries common Docker credential helpers to retrieve credentials based on the registry of the image, such as docker-credential-gcr for images with the registry as gcr.io.

info(String) - Static method in class com.google.cloud.tools.jib.event.events.LogEvent

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

Gets a RegistryAuthenticator for a custom registry server and repository.

initializer(EventDispatcher, String, String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator

Gets a new initializer for RegistryAuthenticator.

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

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

Returns true if tag is the default tag ((@code latest} or empty); false if not.

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

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

isSendCredentialsOverHttpEnabled() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties

Gets whether or not to allow sending authentication information over insecure HTTP connections.

isSerializedExecutionEnabled() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties

Gets whether or not to serialize Jib's execution.

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

Returns true if the ImageReference uses a SHA-256 digest as its tag; false if not.

isUserAgentEnabled() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties

Gets whether or not to enable the User-Agent header.

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

Returns true if registry is a valid registry string.

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

Returns true if repository is a valid repository string.

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

Returns true if tag is a valid tag string.

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

J

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

Generates a Docker context for a Java application.

JavaDockerContextGenerator(JavaLayerConfigurations) - Constructor for class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Constructs a Docker context generator for a Java application.

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

Constructs an image entrypoint for the Java application.

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

Builds LayerConfigurations for a Java application.

JavaLayerConfigurations.Builder - Class in com.google.cloud.tools.jib.frontend

Builds with each layer's files.

Jib - Class in com.google.cloud.tools.jib.api

Build containers with Jib.

JibContainer - Class in com.google.cloud.tools.jib.api

The container built by Jib.

JibContainerBuilder - Class in com.google.cloud.tools.jib.api

Builds a container with Jib.

JibEvent - Interface in com.google.cloud.tools.jib.event

Type for events dispatched by Jib Core.

JibEventType<E extends JibEvent> - Class in com.google.cloud.tools.jib.event

Holds references to all JibEvent types.

JibSystemProperties - Class in com.google.cloud.tools.jib.global

Names of system properties defined/used by Jib.

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.

K

known(Credential, String) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory

Creates a new CredentialRetriever that returns a known Credential.

L

lap() - Method in class com.google.cloud.tools.jib.builder.TimerEventDispatcher

Captures the time since last lap or creation and dispatches an TimerEvent.State.LAP TimerEvent.

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

Captures the time since last lap or creation and dispatches an TimerEvent.State.LAP TimerEvent.

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(Path, AbsoluteUnixPath) - Constructor for class com.google.cloud.tools.jib.image.LayerEntry

Instantiates with a source file and the path to place the source file in the container file system.

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

Exception thrown when accessing non-existent properties of layers.

lifecycle(String) - Static method in class com.google.cloud.tools.jib.event.events.LogEvent

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

Loads an image tarball into the Docker daemon.

LogEvent - Class in com.google.cloud.tools.jib.event.events

Log message event.

LogEvent.Level - Enum in com.google.cloud.tools.jib.event.events

Log levels, in order of verbosity.

LOGGING - Static variable in class com.google.cloud.tools.jib.event.JibEventType

Event with a message to use for logging purposes.

M

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

Finds main classes in a list of class files.

MainClassFinder(ImmutableList<Path>, EventDispatcher) - Constructor for class com.google.cloud.tools.jib.frontend.MainClassFinder

Finds a class with psvm (see class javadoc) in files.

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

The result of a call to MainClassFinder.find().

MainClassFinder.Result.Type - Enum in com.google.cloud.tools.jib.frontend

The type of result.

makeDefaultEntrypoint(AbsoluteUnixPath, List<String>, String) - Static method in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

makeDistrolessJettyEntrypoint() - Static method in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

Constructs the container entrypoint for the gcr.io/distroless/jetty base image.

makeEntrypoint(List<String>, List<String>, String) - Static method in class com.google.cloud.tools.jib.frontend.JavaEntrypointConstructor

Constructs 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

named(ImageReference) - Static method in class com.google.cloud.tools.jib.api.DockerDaemonImage

Instantiate with the image reference to tag the built image with.

named(String) - Static method in class com.google.cloud.tools.jib.api.DockerDaemonImage

Instantiate with the image reference to tag the built image with.

named(ImageReference) - Static method in class com.google.cloud.tools.jib.api.RegistryImage

Instantiate with the image reference to use.

named(String) - Static method in class com.google.cloud.tools.jib.api.RegistryImage

Instantiate with the image reference to use.

named(ImageReference) - Static method in class com.google.cloud.tools.jib.api.TarImage

Configures the output tarball archive with an image reference.

named(String) - Static method in class com.google.cloud.tools.jib.api.TarImage

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

newBaseImageRegistryClientFactory() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Creates a new RegistryClient.Factory for the base image with fields from the build configuration.

newClient() - Static method in class com.google.cloud.tools.jib.docker.DockerClient

Instantiates with the default docker executable.

newClient(Path) - Static method in class com.google.cloud.tools.jib.docker.DockerClient

Instantiates with a custom docker executable.

newLockingOutputStream(Path) - Static method in class com.google.cloud.tools.jib.filesystem.FileOperations

Acquires an exclusive FileLock on the file and opens an OutputStream to write to it.

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

Creates a new RegistryClient.

newTargetImageRegistryClientFactory() - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration

Creates a new RegistryClient.Factory for the target image with fields from the build configuration.

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

Static utility for checking at runtime that the caller attempts to get a result only from a completed AsyncStep by otherwise throwing a runtime exception.

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

Constructs an ImageReference from the image reference components, consisting of an optional registry, a repository, and an optional tag.

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

Parses a string reference into an ImageReference.

parseProtocol(int, String) - Static method in class com.google.cloud.tools.jib.configuration.Port

Gets a Port with protocol parsed from the string form protocolString.

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

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

Represents a port number with a protocol (TCP or UDP).

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) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Gets the BLOB referenced by blobDigest.

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, String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient

Pushes the BLOB.

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.

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

Deserializes a JSON file via a JSON object template with a shared lock on the file

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.

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

Provides known aliases for a given registry.

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

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.

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

Initializer for RegistryAuthenticator.

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

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

Thrown when registry request was unauthorized because credentials weren't sent.

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

RegistryImage - Class in com.google.cloud.tools.jib.api

Defines an image on a container registry that can be used as either a source or target image.

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.

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

Represents a Unix-style path in relative form (does not start at the file system root /).

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

Remove any duplicate layers, keeping the last occurrence of the layer.

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

Builds a reproducible layer Blob from files.

ReproducibleLayerBuilder(ImmutableList<LayerEntry>) - 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

resolve(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Resolves this path against another relative path.

resolve(Path) - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Resolves this path against another relative path (by the name elements of relativePath).

resolve(String) - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Resolves this path against another relative Unix path in string form.

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

Holds an HTTP response.

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

Retrieves the CacheEntry that was built from the layerEntries.

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

Retrieves the CacheEntry for the layer with digest layerDigest.

retrieve() - Method in interface com.google.cloud.tools.jib.configuration.credentials.CredentialRetriever

Fetches the credentials.

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

Retrieves credentials for a registry.

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

Calls the credential helper CLI in the form:

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

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

Executes the build.

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() - 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(DockerClient) - 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

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

S

saveTo(Path) - Method in class com.google.cloud.tools.jib.api.TarImage.Builder

Sets the output file to save the tarball archive to.

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

Sends the request.

SEND_CREDENTIALS_OVER_HTTP - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties

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.

setAdditionalTargetImageTags(Set<String>) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the tags to tag the target image with (in addition to the tag in the target image configuration image reference set via BuildConfiguration.Builder.setTargetImageConfiguration(com.google.cloud.tools.jib.configuration.ImageConfiguration)).

setAllowInsecureRegistries(boolean) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets whether or not to allow communication over HTTP/insecure HTTPS.

setAllowInsecureRegistries(boolean) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

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

setAllowInsecureRegistries(boolean) - Method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator.Initializer

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

Sets whether or not to allow insecure registries (ignoring certificate validation failure or communicating over HTTP if all else fail).

setApplicationLayersCache(Path) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets the directory to use for caching application layers.

setApplicationLayersCacheDirectory(Path) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the location of the cache for storing application layers.

setAuthor(String) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder

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(String) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the base image for the FROM directive.

setBaseImageConfiguration(ImageConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the base image configuration.

setBaseImageLayersCache(Path) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets the directory to use for caching base image layers.

setBaseImageLayersCacheDirectory(Path) - Method in class com.google.cloud.tools.jib.configuration.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.

setComment(String) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder

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

setContainerConfiguration(ContainerConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets configuration parameters for the container.

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

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

setContainerUser(String) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setContainerWorkingDir(String) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

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

Sets the image creation time.

setCreated(String) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate

setCreatedBy(String) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder

setCreationTime(Instant) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the container image creation time.

setCreationTime(Instant) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder

Sets the image creation time.

setCreationTimestamp(Instant) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder

setCredentialRetrievers(List<CredentialRetriever>) - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration.Builder

Sets the providers for registry credentials.

setDockerExecutable(Path) - Method in class com.google.cloud.tools.jib.api.DockerDaemonImage

Sets the path to the docker CLI.

setEmptyLayer(Boolean) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder

setEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the container entrypoint.

setEntrypoint(String...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the container entrypoint.

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

Sets the container entrypoint.

setEntrypoint(List<String>) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the entrypoint to be used as the ENTRYPOINT.

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.api.JibContainerBuilder

Sets the container environment.

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

Sets the container's environment variables, mapping variable name to value.

setEnvironment(Map<String, String>) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the environment variables.

setEventDispatcher(EventDispatcher) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the EventDispatcher to dispatch events with.

setEventHandlers(EventHandlers) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets the EventHandlers to handle events dispatched during Jib's execution.

setExecutorService(ExecutorService) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets the ExecutorService Jib executes on.

setExecutorService(ExecutorService) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the ExecutorService Jib executes on.

setExposedPorts(List<Port>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the ports to expose from the container.

setExposedPorts(Port...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the ports to expose from the container.

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

Sets the container's exposed ports.

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

Sets the exposed ports.

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

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

setFormat(ImageFormat) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the format to build the container image as.

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

Sets the HTTP connection and read timeout in milliseconds.

setLabels(Map<String, String>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the labels for the container.

setLabels(Map<String, String>) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder

Sets the container's labels.

setLabels(Map<String, String>) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the labels.

setLayerConfigurations(List<LayerConfiguration>) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the layers to build.

setLayers(List<LayerConfiguration>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the layers (defined by a list of LayerConfigurations).

setLayers(LayerConfiguration...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the layers.

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

Sets a name for this layer.

setProgramArguments(List<String>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the container entrypoint program arguments.

setProgramArguments(String...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the container entrypoint program arguments.

setProgramArguments(List<String>) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder

Sets the commandline arguments for main.

setProgramArguments(List<String>) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the arguments used in the CMD.

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

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

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

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

Sets the target format of the container image.

setTargetImageConfiguration(ImageConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the target image configuration.

setToolName(String) - Method in class com.google.cloud.tools.jib.api.Containerizer

Sets the name of the tool that is using Jib Core.

setToolName(String) - Method in class com.google.cloud.tools.jib.configuration.BuildConfiguration.Builder

Sets the name of the tool that is executing the build.

setUser(String) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder

Sets the user and group to run the container as.

setUser(String) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder

Sets the user and group to run the container as.

setUser(String) - Method in class com.google.cloud.tools.jib.frontend.JavaDockerContextGenerator

Sets the user for the USER directive.

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

Sets the user/group to run the container as.

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

Sets the User-Agent header.

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

Sets a suffix to append to User-Agent headers.

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

Sets the item in the "WorkingDir" field in the container configuration.

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

SNAPSHOT_FILENAME_SUFFIX - Static variable in class com.google.cloud.tools.jib.frontend.JavaLayerConfigurations

The filename suffix for a maven/gradle snapshot dependency

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

Runs steps for building an image.

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

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

Creates a new TimerEventDispatcher with its parent timer as this.

T

tag(ImageReference, ImageReference) - Method in class com.google.cloud.tools.jib.docker.DockerClient

Tags the image referenced by originalImageReference with a new image reference newImageReference.

TarImage - Class in com.google.cloud.tools.jib.api

Builds to a tarball archive.

TarImage.Builder - Class in com.google.cloud.tools.jib.api

Finishes constructing a TarImage.

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

Builds a tarball archive.

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

tcp(int) - Static method in class com.google.cloud.tools.jib.configuration.Port

Create a new Port with TCP protocol.

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

A temporary directory that tries to delete itself upon close.

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

Creates a new temporary directory under an existing parentDirectory.

TimerEvent - Class in com.google.cloud.tools.jib.event.events

Timer event for timing various part of Jib's execution.

TimerEvent(TimerEvent.State, TimerEvent.Timer, Duration, Duration, String) - Constructor for class com.google.cloud.tools.jib.event.events.TimerEvent

Creates a new TimerEvent.

TimerEvent.State - Enum in com.google.cloud.tools.jib.event.events

The state of the timing.

TimerEvent.Timer - Interface in com.google.cloud.tools.jib.event.events

Defines a timer hierarchy.

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

Handles Timers to dispatch TimerEvents.

TimerEventDispatcher(EventDispatcher, String) - Constructor for class com.google.cloud.tools.jib.builder.TimerEventDispatcher

Creates a new TimerEventDispatcher.

TIMING - Static variable in class com.google.cloud.tools.jib.event.JibEventType

Timer event for timing various part of Jib's execution.

to(RegistryImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer

Gets a new Containerizer that containerizes to a container registry.

to(DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer

Gets a new Containerizer that containerizes to a Docker daemon.

to(TarImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer

Gets a new Containerizer that containerizes to a tarball archive.

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

Convert a JsonTemplate to a Blob of the JSON string.

toBlob(List<? extends JsonTemplate>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper

Convert a list of JsonTemplate 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.

toBuildSteps(BuildConfiguration) - Method in class com.google.cloud.tools.jib.api.DockerDaemonImage

toBuildSteps(BuildConfiguration) - Method in class com.google.cloud.tools.jib.api.RegistryImage

toBuildSteps(BuildConfiguration) - Method in class com.google.cloud.tools.jib.api.TarImage

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.

toImageConfiguration() - Method in class com.google.cloud.tools.jib.api.DockerDaemonImage

toImageConfiguration() - Method in class com.google.cloud.tools.jib.api.RegistryImage

toImageConfiguration() - Method in class com.google.cloud.tools.jib.api.TarImage

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

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

Stringifies the port with protocol, in the form <port>/<protocol>.

toString() - Method in class com.google.cloud.tools.jib.filesystem.AbsoluteUnixPath

Returns the string form of the absolute Unix-style path.

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

Stringifies the ImageReference.

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

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

Stringifies the ImageReference, without hiding the tag.

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

U

udp(int) - Static method in class com.google.cloud.tools.jib.configuration.Port

Create a new Port with UDP protocol.

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

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

Returns true if the ImageReference uses the default tag ((@code latest} or empty); false if not

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.event.events.LogEvent.Level

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

valueOf(String) - Static method in enum com.google.cloud.tools.jib.event.events.TimerEvent.State

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

valueOf(String) - Static method in enum com.google.cloud.tools.jib.frontend.MainClassFinder.Result.Type

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.event.events.LogEvent.Level

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.event.events.TimerEvent.State

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.frontend.MainClassFinder.Result.Type

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.

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

The project version.

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

waitOnWriteTarFileStep() - 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(String) - Static method in class com.google.cloud.tools.jib.event.events.LogEvent

withAdditionalTag(String) - Method in class com.google.cloud.tools.jib.api.Containerizer

Adds an additional tag to tag the target image with.

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

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

Initializes the cache using cacheDirectory for storage.

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

Gets an ImageReference with the same registry and repository, but a different tag.

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

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

Saves a cache entry with a compressed layer Blob.

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

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.

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

Writes the BLOB to a file with an exclusive lock.

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

Writes the BLOB to a string with UTF-8 decoding.

writeUncompressedLayer(Blob, ImmutableList<LayerEntry>) - Method in class com.google.cloud.tools.jib.cache.Cache

Saves a cache entry with an uncompressed layer Blob and an additional selector digest.

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