A B C D E F G H I J K L M N O P R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- accept(ProgressEvent) - Method in class com.google.cloud.tools.jib.event.progress.ProgressEventHandler
- accept(Long) - Method in class com.google.cloud.tools.jib.event.progress.ThrottledAccumulatingConsumer
- accept(Path) - Method in interface com.google.cloud.tools.jib.filesystem.PathConsumer
- action(Retry.Action<E>) - Static method in class com.google.cloud.tools.jib.cache.Retry
-
Create a retryable action.
- add(Class<E>, Consumer<? super E>) - Method in class com.google.cloud.tools.jib.event.EventHandlers.Builder
- addBlobEntry(Blob, long, String, Instant) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
-
Adds a blob to the archive.
- addByteEntry(byte[], String, Instant) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
-
Adds a blob to the archive.
- addClasses(Path) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds the contents of a classes directory to the image.
- addClasses(Path, Predicate<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds the contents of a classes directory to the image.
- 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. - addDependencies(Path...) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds dependency JARs to the image.
- addDependencies(List<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds dependency JARs to the image.
- addEntry(LayerEntry) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer.
- addEntry(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer.
- addEntry(Path, AbsoluteUnixPath, FilePermissions) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer with the given permissions.
- addEntry(Path, AbsoluteUnixPath, FilePermissions, Instant) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer with the given permissions and file modification time.
- addEntry(Path, AbsoluteUnixPath, Instant) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer with the given file modification time.
- addEntryRecursive(Path, AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer.
- addEntryRecursive(Path, AbsoluteUnixPath, FilePermissionsProvider) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer.
- addEntryRecursive(Path, AbsoluteUnixPath, FilePermissionsProvider, ModificationTimeProvider) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Adds an entry to the layer.
- addEnvironment(String, String) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Adds an environment entry to the container configuration.
- 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
-
Adds 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
- addEventHandler(Class<E>, Consumer<? super E>) - Method in class com.google.cloud.tools.jib.api.Containerizer
- addEventHandler(Consumer<JibEvent>) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Adds the
eventConsumer
to handle allJibEvent
types. - addExposedPort(Port) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Adds a port to expose from the container.
- addExposedPort(Port) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Adds an exposed port entry to the container configuration.
- addExposedPorts(Set<Port>) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Adds items to the "ExposedPorts" field in the container configuration.
- addFileEntriesLayer(FileEntriesLayer) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Adds a layer (defined by a
FileEntriesLayer
). - 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
- addJvmFlag(String) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds a JVM flag to use when starting the application.
- addJvmFlags(String...) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds JVM flags to use when starting the application.
- addJvmFlags(List<String>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds JVM flags to use when starting the application.
- 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.configuration.ContainerConfiguration.Builder
-
Add a label to the container configuration.
- 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(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
- addLayer(LayerConfiguration) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Deprecated.
- addLayer(Layer) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Adds a layer to the image.
- 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 andpathInContainer
as the path to copy the source files to in the container file system. - addLayer(List<Path>, String) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Adds a new layer to the container with
files
as the source files andpathInContainer
as the path to copy the source files to in the container file system. - 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.DockerManifestEntryTemplate
- addManifest(BlobDescriptor, String) - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
-
Adds a manifest reference with the given
BlobDescriptor
. - addManifest(OciIndexTemplate.ManifestDescriptorTemplate) - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
-
Adds a manifest.
- addManifest(V22ManifestListTemplate.ManifestDescriptorTemplate) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate
-
Adds a manifest.
- addPlatform(String, String) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Adds a desired image platform (OS and architecture pair).
- addPlatform(String, String) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Adds a desired image platform (OS and architecture pair).
- addProjectDependencies(Path...) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds project dependency JARs to the image.
- addProjectDependencies(List<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds project dependency JARs to the image.
- addRegistryMirrors(String, List<String>) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Adds mirrors for a base image registry.
- addRepoTag(String) - Method in class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- addResources(Path) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds the contents of a resources directory to the image.
- addResources(Path, Predicate<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds the contents of a resources directory to the image.
- addSnapshotDependencies(Path...) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds snapshot dependency JARs to the image.
- addSnapshotDependencies(List<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds snapshot dependency JARs to the image.
- addTarArchiveEntry(TarArchiveEntry) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
-
Adds a
TarArchiveEntry
to the archive. - addToClasspath(Path...) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds additional files to the classpath.
- addToClasspath(List<Path>) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Adds additional files to the classpath.
- addVolume(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Adds a directory that may hold an externally mounted volume.
- addVolume(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Adds a volume entry to the container configuration.
- addVolumes(Set<AbsoluteUnixPath>) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Adds items to the "Volumes" field in the container configuration.
- Allocation - Class in com.google.cloud.tools.jib.event.progress
-
Represents a Decentralized Allocation Tree (DAT) node.
- applyContainerBuildPlan(ContainerBuildPlan) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Internal method.
- areAllLayersCached(ManifestTemplate) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Returns
true
if all image layers described in a manifest exist in the cache. - at(Path) - Static method in class com.google.cloud.tools.jib.api.TarImage
-
Constructs a
TarImage
with the specified path. - authenticatePull(Credential) - Method in class com.google.cloud.tools.jib.registry.RegistryAuthenticator
-
Authenticates permissions to pull.
- authenticatePush(Credential) - 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. - authPullByWwwAuthenticate(String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Configure basic authentication or attempts bearer authentication for pulling based on the specified authentication method in a server response.
- 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.
- begin(BuildContext) - Static method in class com.google.cloud.tools.jib.builder.steps.StepsRunner
-
Starts building the steps to run.
- 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
-backedHttpContent
. - BlobHttpContent(Blob, String) - Constructor for class com.google.cloud.tools.jib.http.BlobHttpContent
- BlobHttpContent(Blob, String, Consumer<Long>) - Constructor for class com.google.cloud.tools.jib.http.BlobHttpContent
-
Create a new BlobHttpClient.
- Blobs - Class in com.google.cloud.tools.jib.blob
-
Static methods for
Blob
. - build() - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Returns the built
LayerConfiguration
. - build() - Method in class com.google.cloud.tools.jib.cache.CachedLayer.Builder
-
Creates a CachedLayer instance.
- build() - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Builds a new
BuildContext
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.DockerHealthCheck.Builder
- build() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration.Builder
-
Builds the
ImageConfiguration
. - build() - Method in class com.google.cloud.tools.jib.event.EventHandlers.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
-
Create an
Image
instance. - build() - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder
-
Create a new history entry.
- 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.
- BuildContext - Class in com.google.cloud.tools.jib.configuration
-
Build context for the builder process.
- BuildContext.Builder - Class in com.google.cloud.tools.jib.configuration
-
Builds an immutable
BuildContext
. - builder() - Static method in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Gets a new
LayerConfiguration.Builder
forLayerConfiguration
. - builder() - Static method in class com.google.cloud.tools.jib.cache.CachedLayer
-
Creates a new
CachedLayer.Builder
for aCachedLayer
. - builder() - Static method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Creates a new
BuildContext.Builder
to build aBuildContext
. - builder() - Static method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
-
Constructs a builder for a
ContainerConfiguration
. - builder() - Static method in class com.google.cloud.tools.jib.event.EventHandlers
-
Creates a new
EventHandlers.Builder
. - builder() - Static method in class com.google.cloud.tools.jib.http.Request
- builder() - Static method in class com.google.cloud.tools.jib.image.json.HistoryEntry
-
Creates a builder for a
HistoryEntry
. - builder(ImageReference) - Static method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
-
Constructs a builder for an
ImageConfiguration
. - builder(Class<? extends ManifestTemplate>) - Static method in class com.google.cloud.tools.jib.image.Image
- Builder() - Constructor for class com.google.cloud.tools.jib.event.EventHandlers.Builder
- Builder() - Constructor for class com.google.cloud.tools.jib.http.Request.Builder
- BuildResult - Class in com.google.cloud.tools.jib.builder.steps
-
Used to record the results of a build.
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.api
-
Thrown when a directory to be used as the cache could not be created.
- CacheDirectoryCreationException(Throwable) - Constructor for exception com.google.cloud.tools.jib.api.CacheDirectoryCreationException
- CachedLayer - Class in com.google.cloud.tools.jib.cache
-
A reference to an image layer that is in the Cache.
- CachedLayer.Builder - Class in com.google.cloud.tools.jib.cache
-
Builds a
CachedLayer
. - call() - Method in class com.google.cloud.tools.jib.builder.steps.WriteTarFileStep
- call(String, URL, Request) - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Sends the request.
- checkBlob(DescriptorDigest) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Check if a blob is on the registry.
- 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. - checkManifest(String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Check if a manifest referred to by
imageQualifier
(tag or digest) exists on the registry. - checkProxyPortProperty() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Checks if
http.proxyPort
andhttps.proxyPort
system properties are in the [0..65535] range when set. - CLASSES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- CliDockerClient - Class in com.google.cloud.tools.jib.docker
-
Calls out to the
docker
CLI. - CliDockerClient(Path, Map<String, String>) - Constructor for class com.google.cloud.tools.jib.docker.CliDockerClient
-
Instantiates with a
docker
executable and environment variables. - CliDockerClient.DockerImageDetails - Class in com.google.cloud.tools.jib.docker
-
Contains the size, image ID, and diff IDs of an image inspected with
docker inspect
. - close() - Method in class com.google.cloud.tools.jib.builder.ProgressEventDispatcher
-
Emits the remaining allocation units as progress units in a
ProgressEvent
. - 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.configuration.BuildContext
- close() - Method in class com.google.cloud.tools.jib.event.progress.ThrottledAccumulatingConsumer
- close() - Method in class com.google.cloud.tools.jib.filesystem.LockFile
-
Releases the lock file.
- close() - Method in class com.google.cloud.tools.jib.filesystem.TempDirectoryProvider
- close() - Method in class com.google.cloud.tools.jib.http.NotifyingOutputStream
- close() - Method in class com.google.cloud.tools.jib.http.Response
- 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.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.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.event.progress - package com.google.cloud.tools.jib.event.progress
- 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
- computeDigest() - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream
-
Computes the hash and returns it along with the size of the bytes written to compute the hash.
- computeDigest(WritableContents) - Static method in class com.google.cloud.tools.jib.hash.Digests
-
Computes the digest by consuming the contents.
- computeDigest(WritableContents, OutputStream) - Static method in class com.google.cloud.tools.jib.hash.Digests
-
Computes the digest by consuming the contents while copying it to an
OutputStream
. - computeDigest(JsonTemplate) - Static method in class com.google.cloud.tools.jib.hash.Digests
- computeDigest(JsonTemplate, OutputStream) - Static method in class com.google.cloud.tools.jib.hash.Digests
- computeDigest(InputStream) - Static method in class com.google.cloud.tools.jib.hash.Digests
- computeDigest(InputStream, OutputStream) - Static method in class com.google.cloud.tools.jib.hash.Digests
-
Computes the digest by consuming the contents of an
InputStream
while copying it to anOutputStream
. - computeJsonDigest(JsonTemplate) - Static method in class com.google.cloud.tools.jib.hash.Digests
- computeJsonDigest(List<? extends JsonTemplate>) - Static method in class com.google.cloud.tools.jib.hash.Digests
- configureBasicAuth() - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Configure basic authentication on this registry client.
- 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.
- Containerizer - Class in com.google.cloud.tools.jib.api
-
Configures how to containerize.
- ContentDescriptorTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate
-
Necessary for Jackson to create from JSON.
- copy(ImmutableList<Path>, Path) - Static method in class com.google.cloud.tools.jib.filesystem.FileOperations
-
Copies
sourceFiles
to thedestDir
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
. - create(String, long) - Method in interface com.google.cloud.tools.jib.builder.ProgressEventDispatcher.Factory
-
Creates the
ProgressEventDispatcher
with an associatedAllocation
. - create(String, Path) - Static method in class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever
- createForLegacyFormat(String, Path) - Static method in class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever
- Credential - Class in com.google.cloud.tools.jib.api
-
Holds credentials (username and password).
- 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.api
-
Retrieves credentials for a registry.
- CredentialRetrieverFactory - Class in com.google.cloud.tools.jib.frontend
-
Static factories for various
CredentialRetriever
s.
D
- debug(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- DEBUG - com.google.cloud.tools.jib.api.LogEvent.Level
-
Useful for debugging.
- DEFAULT_APP_ROOT - Static variable in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
The default app root in the image.
- DEFAULT_APPLICATION_CACHE_DIRECTORY_NAME - Static variable in class com.google.cloud.tools.jib.api.Containerizer
- 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_DOCKER_CLIENT - Static variable in class com.google.cloud.tools.jib.docker.CliDockerClient
-
Default path to the docker executable.
- DEFAULT_FILE_PERMISSIONS_PROVIDER - Static variable in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Provider that returns default file permissions (644 for files, 755 for directories).
- DEFAULT_MODIFICATION_TIME - Static variable in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Default file modification time (EPOCH + 1 second).
- DEFAULT_MODIFICATION_TIME_PROVIDER - Static variable in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Provider that returns default file modification time (EPOCH + 1 second).
- DEFAULT_WEB_APP_ROOT - Static variable in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Deprecated.Use the string
"/jetty/webapps/ROOT"
. - DEPENDENCIES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- describeContainer() - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Deprecated.
- DescriptorDigest - Class in com.google.cloud.tools.jib.api
-
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 itsDescriptorDigest
. - DigestOnlyLayer(DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.image.DigestOnlyLayer
-
Instantiate with a
DescriptorDigest
. - Digests - Class in com.google.cloud.tools.jib.hash
-
Utility class for computing a digest for various inputs while optionally writing to an output stream.
- 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.EventHandlers
-
Dispatches
jibEvent
to all the handlers that can handle it. - dispatchProgress(long) - Method in class com.google.cloud.tools.jib.builder.ProgressEventDispatcher
-
Dispatches a
ProgressEvent
representingprogressUnits
of progress on the managedProgressEventDispatcher.allocation
. - DOCKER_DAEMON_IMAGE_PREFIX - Static variable in class com.google.cloud.tools.jib.api.Jib
- DockerClient - Interface in com.google.cloud.tools.jib.api
- DockerClientResolver - Class in com.google.cloud.tools.jib.docker
- dockerConfig() - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetriever
that tries to retrieve credentials from Docker config (located atSystem.getProperty("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.
- DockerConfigTemplate - Class in com.google.cloud.tools.jib.registry.credentials.json
-
Template for a Docker config file.
- DockerConfigTemplate(Map<String, DockerConfigTemplate.AuthTemplate>) - 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 underauths
. - 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 asdocker-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 asdocker-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
. - DockerCredentialHelper(String, Path, Map<String, String>) - 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.
- DockerHealthCheck - Class in com.google.cloud.tools.jib.configuration
-
Configuration information for performing healthchecks on a Docker container.
- DockerHealthCheck.Builder - Class in com.google.cloud.tools.jib.configuration
-
Builds the immutable
DockerHealthCheck
. - DockerImageDetails() - Constructor for class com.google.cloud.tools.jib.docker.CliDockerClient.DockerImageDetails
- dockerLoadSteps(DockerClient) - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner
-
Add steps for loading an image to docker daemon.
- DockerManifestEntryTemplate - Class in com.google.cloud.tools.jib.docker.json
-
JSON Template for a loadable Docker Manifest entry.
- DockerManifestEntryTemplate() - Constructor for class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- doPullBearerAuth() - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Attempts bearer authentication for pull.
- doPushBearerAuth() - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Attempts bearer authentication for pull and push.
E
- equals(Object) - Method in class com.google.cloud.tools.jib.api.Credential
- equals(Object) - Method in class com.google.cloud.tools.jib.api.DescriptorDigest
-
Two digest objects are equal if their digest strings are equal.
- equals(Object) - Method in class com.google.cloud.tools.jib.api.ImageReference
- equals(Object) - Method in class com.google.cloud.tools.jib.api.JibContainer
- equals(Object) - Method in class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.
- equals(Object) - Method in class com.google.cloud.tools.jib.api.LogEvent
- equals(Object) - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
-
Checks if two
BlobDescriptor
s are equal. - equals(Object) - Method in class com.google.cloud.tools.jib.builder.steps.BuildResult
- equals(Object) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- equals(Object) - Method in class com.google.cloud.tools.jib.http.Authorization
- equals(Object) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry
- error(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- ERROR - com.google.cloud.tools.jib.api.LogEvent.Level
-
Something went wrong.
- 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
. - EventHandlers - Class in com.google.cloud.tools.jib.event
-
Builds a set of event handlers to handle
JibEvent
s. - EventHandlers.Builder - Class in com.google.cloud.tools.jib.event
-
Builder for
EventHandlers
. - EXTRA_FILES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- extract(Path, Path) - Static method in class com.google.cloud.tools.jib.tar.TarExtractor
-
Extracts a tarball to the specified destination.
- extract(Path, Path, boolean) - Static method in class com.google.cloud.tools.jib.tar.TarExtractor
-
Extracts a tarball to the specified destination.
F
- factory(EventHandlers, String, String, FailoverHttpClient) - Static method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Creates a new
RegistryClient.Factory
for building aRegistryClient
. - factory(EventHandlers, String, String, String, FailoverHttpClient) - Static method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Creates a new
RegistryClient.Factory
for building aRegistryClient
. - FailoverHttpClient - Class in com.google.cloud.tools.jib.http
-
Thread-safe HTTP client that can automatically failover from secure HTTPS to insecure HTTPS or HTTP.
- FailoverHttpClient(boolean, boolean, Consumer<LogEvent>) - Constructor for class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Create a new FailoverHttpclient.
- 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(List<Path>, Consumer<LogEvent>) - Static method in class com.google.cloud.tools.jib.api.MainClassFinder
-
Tries to find classes with
psvm
(see class javadoc) infiles
. - FINISHED - com.google.cloud.tools.jib.event.events.TimerEvent.State
-
The timer has finished timing.
- flush() - Method in class com.google.cloud.tools.jib.http.NotifyingOutputStream
- forImage(ImageReference, Consumer<LogEvent>) - Static method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetrieverFactory
for an image. - forImage(ImageReference, Consumer<LogEvent>, Map<String, String>) - Static method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetrieverFactory
for an image. - from(DockerClient, DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from a base image stored in the Docker cache.
- from(DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Starts building the container from a base image stored in the Docker cache.
- from(DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from a base image stored in the Docker cache.
- from(ImageReference) - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Creates a new
JavaContainerBuilder
with the specified base image reference. - 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.JavaContainerBuilder
-
Creates a new
JavaContainerBuilder
with the specified base image. - from(RegistryImage) - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from a registry base image.
- from(TarImage) - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Starts building the container from a tarball.
- from(TarImage) - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from a tarball.
- from(WritableContents, boolean) - Static method in class com.google.cloud.tools.jib.blob.Blobs
- from(JsonTemplate) - Static method in class com.google.cloud.tools.jib.blob.Blobs
- from(InputStream) - Static method in class com.google.cloud.tools.jib.blob.Blobs
- from(String) - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Creates a new
JavaContainerBuilder
with the specified base image reference. - from(String) - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from a base image.
- from(String) - Static method in class com.google.cloud.tools.jib.blob.Blobs
-
Creates a
StringBlob
with UTF-8 encoding. - from(String, String) - Static method in class com.google.cloud.tools.jib.api.Credential
-
Gets a
Credential
configured with a username and password. - from(Path) - Static method in class com.google.cloud.tools.jib.blob.Blobs
- fromBasicCredentials(String, String) - Static method in class com.google.cloud.tools.jib.http.Authorization
-
Create an authentication from basic credentials.
- fromBearerToken(String) - Static method in class com.google.cloud.tools.jib.http.Authorization
-
Create an authentication from bearer token.
- fromCommand(List<String>) - Static method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Creates a new
DockerHealthCheck.Builder
with the specified command. - fromDigest(String) - Static method in class com.google.cloud.tools.jib.api.DescriptorDigest
-
Creates a new instance from a valid digest string.
- fromDistroless() - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Deprecated.Use
from()
with the image referencegcr.io/distroless/java
. - fromDistrolessJetty() - Static method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Deprecated.Use
from()
with the image referencegcr.io/distroless/java/jetty
and change the app root by callingJavaContainerBuilder.setAppRoot("/jetty/webapps/ROOT")
. - fromHash(String) - Static method in class com.google.cloud.tools.jib.api.DescriptorDigest
-
Creates a new instance from a valid hash string.
- fromScratch() - Static method in class com.google.cloud.tools.jib.api.Jib
-
Starts building the container from an empty base image.
G
- get(URL, Request) - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Sends the request with method GET.
- getAliasesGroup(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAliasGroup
-
Returns the list of registry aliases for the given
registry
, includingregistry
as the first element. - getAllocation() - Method in class com.google.cloud.tools.jib.event.events.ProgressEvent
-
Gets the
Allocation
this progress event accounts for. - getAllocationUnits() - Method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Gets the allocation units this allocation holds.
- getAllTargetImageTags() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Returns all image tags configured for this build.
- getAlwaysCacheBaseImage() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets whether or not to force caching the base images.
- getAnnotations() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate
- getApplicationLayersCache() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets the
Cache
for application layers. - getArchitecture() - Method in class com.google.cloud.tools.jib.image.Image
- getArchitecture() - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Returns the architecture for which this container was built.
- getArchitecture() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate.ManifestDescriptorTemplate.Platform
- getArchitecture() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate.Platform
- getAuth() - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate.AuthTemplate
- getAuths() - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate
- getBaseImageConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getBaseImageLayersCache() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets the
Cache
for base image layers. - 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
-
Returns this layer's contents.
- 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.cache.CachedLayer
- getBlobDescriptor() - Method in class com.google.cloud.tools.jib.image.DigestOnlyLayer
- getBlobDescriptor() - Method in interface com.google.cloud.tools.jib.image.Layer
-
Returns this layer's content descriptor.
- 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
-
Returns the content of the HTTP response.
- getCacheHome() - Static method in class com.google.cloud.tools.jib.filesystem.XdgDirectories
- getCode() - Method in class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate
- getCommand() - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Gets the optional healthcheck command.
- getConfig() - Method in class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- getConfig() - Method in class com.google.cloud.tools.jib.image.json.ManifestAndConfigTemplate
-
Gets the container configuration.
- getConfigHome() - Static method in class com.google.cloud.tools.jib.filesystem.XdgDirectories
- getContainerConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getContainerConfiguration() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate
-
Returns the content descriptor of the container configuration.
- getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator
-
Gets the container configuration.
- getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.OciManifestTemplate
- getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
-
Attempts to parse the container configuration JSON (of format
application/vnd.docker.container.image.v1+json
) from thev1Compatibility
value of the firsthistory
entry, which corresponds to the latest layer. - getContainerConfiguration() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate
- getContent() - Method in exception com.google.cloud.tools.jib.http.ResponseException
- getContentLength() - Method in class com.google.cloud.tools.jib.http.Response
-
Returns the content length from the header.
- 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
- 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
- getDescription() - Method in class com.google.cloud.tools.jib.event.events.TimerEvent
-
Gets the description associated with this event.
- getDescription() - Method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Gets a user-facing description of what this allocation represents.
- getDiffId() - Method in class com.google.cloud.tools.jib.cache.CachedLayer
- getDiffId() - Method in class com.google.cloud.tools.jib.image.DigestOnlyLayer
- getDiffId() - Method in interface com.google.cloud.tools.jib.image.Layer
-
Returns this layer's diff ID.
- getDiffId() - Method in class com.google.cloud.tools.jib.image.ReferenceLayer
- getDiffId() - Method in class com.google.cloud.tools.jib.image.ReferenceNoDiffIdLayer
- getDiffIds() - Method in interface com.google.cloud.tools.jib.api.ImageDetails
- getDiffIds() - Method in class com.google.cloud.tools.jib.docker.CliDockerClient.DockerImageDetails
-
Return a list of diff ids of the layers in the image.
- getDigest() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets the digest portion of the
ImageReference
. - getDigest() - Method in class com.google.cloud.tools.jib.api.JibContainer
-
Gets the digest of the registry image manifest built by Jib.
- getDigest() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
- getDigest() - Method in class com.google.cloud.tools.jib.cache.CachedLayer
- getDigest() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate
- getDigest() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- getDigest() - Method in class com.google.cloud.tools.jib.registry.ManifestAndDigest
-
Gets the digest.
- getDigestsForPlatform(String, String) - Method in interface com.google.cloud.tools.jib.image.json.ManifestListTemplate
-
Returns a list of digests for a specific platform found in the manifest list.
- getDigestsForPlatform(String, String) - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
- getDigestsForPlatform(String, String) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate
- getDockerClient() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getDockerConfigFile() - Method in class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever
- 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.
- getEnablePlatformTags() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- 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(ResponseException) - Static method in class com.google.cloud.tools.jib.registry.ErrorResponseUtil
-
Extract an
ErrorCodes
response from the error object encoded in anHttpResponseException
. - getErrors() - Method in class com.google.cloud.tools.jib.registry.json.ErrorResponseTemplate
- getEventHandlers() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getExecutorService() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- 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.api.LayerEntry
-
Deprecated.Gets the extraction path.
- getFileEntriesLayers() - Method in class com.google.cloud.tools.jib.api.JibContainerDescription
-
Returns a list of "user configured" layers, does not include base layer information.
- getFoundMainClass() - Method in class com.google.cloud.tools.jib.api.MainClassFinder.Result
-
Gets the found main class.
- getFoundMainClasses() - Method in class com.google.cloud.tools.jib.api.MainClassFinder.Result
-
Gets the found main classes.
- getFractionOfRoot() - Method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Gets how much of the root allocation each of the allocation units of this allocation accounts for.
- getFsLayers() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
- getHash() - Method in class com.google.cloud.tools.jib.api.DescriptorDigest
- getHeader(String) - Method in class com.google.cloud.tools.jib.http.Response
-
Returns a list of the header string values for the given header name.
- getHeaders() - Method in exception com.google.cloud.tools.jib.http.ResponseException
- getHealthCheck() - Method in class com.google.cloud.tools.jib.image.Image
- getHistory() - Method in class com.google.cloud.tools.jib.image.Image
- getHost(String) - Static method in class com.google.cloud.tools.jib.registry.RegistryAliasGroup
-
Returns the server host name to use for the given registry.
- getHttpResponseException() - Method in exception com.google.cloud.tools.jib.api.RegistryUnauthorizedException
- getHttpTimeout() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets the HTTP connection/read timeouts for registry interactions in milliseconds.
- getIdentityToken() - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate.AuthTemplate
- getImage() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getImageDigest() - Method in class com.google.cloud.tools.jib.builder.steps.BuildResult
- getImageFormat() - Method in class com.google.cloud.tools.jib.image.Image
- getImageId() - Method in interface com.google.cloud.tools.jib.api.ImageDetails
- getImageId() - Method in class com.google.cloud.tools.jib.api.JibContainer
-
Gets the digest of the container configuration built by Jib.
- getImageId() - Method in class com.google.cloud.tools.jib.builder.steps.BuildResult
- getImageId() - Method in class com.google.cloud.tools.jib.docker.CliDockerClient.DockerImageDetails
- getImageName() - Method in exception com.google.cloud.tools.jib.api.RegistryAuthenticationFailedException
-
The image being authenticated.
- getImageQualifier() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getImageReference() - Method in exception com.google.cloud.tools.jib.api.RegistryUnauthorizedException
- getImageRegistry() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getImageRepository() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getInterval() - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Gets the optional healthcheck interval.
- getInvalidReference() - Method in exception com.google.cloud.tools.jib.api.InvalidImageReferenceException
- getLabels() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- getLabels() - Method in class com.google.cloud.tools.jib.image.Image
- getLayerConfigurations() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets the configurations for building the layers.
- getLayerCount() - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
- getLayerDiffId(int) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
- getLayerDigests() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
-
Returns a list of descriptor digests for the layers in the image.
- getLayerEntries() - Method in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Gets the list of entries.
- getLayerFiles() - Method in class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- getLayers() - Method in class com.google.cloud.tools.jib.image.Image
- getLayers() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate
-
Returns an unmodifiable view of the layers.
- 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
- getLevel() - Method in class com.google.cloud.tools.jib.api.LogEvent
-
Gets the log level to log at.
- getManifest() - Method in class com.google.cloud.tools.jib.image.json.ManifestAndConfigTemplate
-
Gets the manifest.
- getManifest() - Method in class com.google.cloud.tools.jib.registry.ManifestAndDigest
-
Gets the manifest.
- getManifestDigest() - Method in class com.google.cloud.tools.jib.image.json.ManifestAndConfigTemplate
-
Gets the digest of the manifest.
- getManifestList() - Method in class com.google.cloud.tools.jib.image.json.ImageMetadataTemplate
- getManifestListTemplate(Class<T>) - Method in class com.google.cloud.tools.jib.image.json.ManifestListGenerator
-
Generates a manifest list JSON for the given
Image
s. - getManifestMediaType() - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate
-
Returns the media type for this manifest, specific to the image format.
- getManifestMediaType() - Method in interface com.google.cloud.tools.jib.image.json.ManifestTemplate
- getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
- getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.OciManifestTemplate
- getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
- getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate
- getManifestMediaType() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate
- getManifests() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
- getManifests() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate
- getManifestsAndConfigs() - Method in class com.google.cloud.tools.jib.image.json.ImageMetadataTemplate
- getManifestTemplate(Class<T>, BlobDescriptor) - Method in class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator
-
Gets the manifest as a JSON template.
- getMediaType() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- getMessage() - Method in class com.google.cloud.tools.jib.api.LogEvent
-
Gets the log message.
- getMessage() - Method in class com.google.cloud.tools.jib.registry.json.ErrorEntryTemplate
- getModificationTime() - Method in class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.Returns the modification time of the file in the entry.
- getName() - Method in enum com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- getName() - Method in class com.google.cloud.tools.jib.api.LayerConfiguration
-
Deprecated.Gets the name.
- getOs() - Method in class com.google.cloud.tools.jib.image.Image
- getOs() - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Returns the operating system for which this container was built.
- getOs() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate.ManifestDescriptorTemplate.Platform
- getOs() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate.Platform
- getParent() - Method in interface com.google.cloud.tools.jib.event.events.TimerEvent.Timer
-
Gets the parent of this
TimerEvent.Timer
. - getParent() - Method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Gets the parent allocation, or
Optional.empty()
if this is a root allocation. - getPassword() - Method in class com.google.cloud.tools.jib.api.Credential
-
Gets the password.
- getPassword() - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate.AuthTemplate
- getPermissions() - Method in class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.Gets the file permissions on the container.
- getPlatform() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate.ManifestDescriptorTemplate
- getPlatform() - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- getPlatforms() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- getProgramArguments() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- getProgramArguments() - Method in class com.google.cloud.tools.jib.image.Image
- getProgress() - Method in class com.google.cloud.tools.jib.event.progress.ProgressEventHandler.Update
-
Gets the overall progress, with
1.0
meaning fully complete. - getQualifier() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets the digest portion of the
ImageReference
if set, else returns the tag. - getRegistry() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets the registry portion of the
ImageReference
. - getRegistryMirrors() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets the registry mirrors.
- getRepository() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets the repository portion of the
ImageReference
. - getRepoTags() - Method in class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- getRequestUrl() - Method in class com.google.cloud.tools.jib.http.Response
-
Returns the original request URL.
- getRetries() - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Gets the optional healthcheck retry count.
- getSchemaVersion() - Method in interface com.google.cloud.tools.jib.image.json.ManifestTemplate
- getSchemaVersion() - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
- 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.V22ManifestListTemplate
- 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.api.RegistryAuthenticationFailedException
-
The server being authenticated.
- getSize() - Method in interface com.google.cloud.tools.jib.api.ImageDetails
- getSize() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
- getSize() - Method in class com.google.cloud.tools.jib.cache.CachedLayer
- getSize() - Method in class com.google.cloud.tools.jib.docker.CliDockerClient.DockerImageDetails
- getSize() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate
- getSourceFile() - Method in class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.Gets the source file.
- getStartPeriod() - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Gets the optional healthcheck start period.
- 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
-
Returns the HTTP status code of the response.
- getStatusCode() - Method in exception com.google.cloud.tools.jib.http.ResponseException
- getTag() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets the tag portion of the
ImageReference
. - getTags() - Method in class com.google.cloud.tools.jib.api.JibContainer
-
Get the tags applied to the container.
- getTargetFormat() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getTargetImage() - Method in class com.google.cloud.tools.jib.api.JibContainer
-
Get the target image that was built.
- getTargetImageConfiguration() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getTarPath() - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration
- getTimeout() - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck
-
Gets the optional healthcheck timeout.
- 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.BuildContext
- getToolVersion() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
- getTotalLayerSize() - Method in class com.google.cloud.tools.jib.image.ImageTarball
-
Returns the total size of the image's layers in bytes.
- getTransportsCreated() - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
- getType() - Method in class com.google.cloud.tools.jib.api.MainClassFinder.Result
-
Gets the type of the result.
- getType() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent
- getUnfinishedLeafTasks() - Method in class com.google.cloud.tools.jib.event.progress.ProgressEventHandler.Update
-
Gets a list of the unfinished "leaf" tasks in the order in which those tasks were encountered.
- getUnits() - Method in class com.google.cloud.tools.jib.event.events.ProgressEvent
-
Gets the units of progress this progress event accounts for in the associated
Allocation
. - getUrls() - Method in class com.google.cloud.tools.jib.image.json.BuildableManifestTemplate.ContentDescriptorTemplate
- 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.api.Credential
-
Gets the username.
- getUsername() - Method in class com.google.cloud.tools.jib.registry.credentials.json.DockerConfigTemplate.AuthTemplate
- getVolumes() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- getVolumes() - Method in class com.google.cloud.tools.jib.image.Image
- getWorkingDirectory() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- 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.
- googleApplicationDefaultCredentials() - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetriever
that tries to retrieve credentials from Google Application Default Credentials.
H
- 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.api.DescriptorDigest
- hashCode() - Method in class com.google.cloud.tools.jib.api.Credential
- hashCode() - Method in class com.google.cloud.tools.jib.api.DescriptorDigest
-
Pass-through hash code of the digest string.
- hashCode() - Method in class com.google.cloud.tools.jib.api.ImageReference
- hashCode() - Method in class com.google.cloud.tools.jib.api.JibContainer
- hashCode() - Method in class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.
- hashCode() - Method in class com.google.cloud.tools.jib.api.LogEvent
- hashCode() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
- hashCode() - Method in class com.google.cloud.tools.jib.builder.steps.BuildResult
- hashCode() - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration
- hashCode() - Method in class com.google.cloud.tools.jib.http.Authorization
- hashCode() - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry
- 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 - Class in com.google.cloud.tools.jib.image
-
Represents an image.
- Image.Builder - 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 a base or target image reference.
- ImageConfiguration.Builder - Class in com.google.cloud.tools.jib.configuration
-
Builder for instantiating an
ImageConfiguration
. - ImageDetails - Interface in com.google.cloud.tools.jib.api
- ImageMetadataTemplate - Class in com.google.cloud.tools.jib.image.json
-
A bundle of an image manifest list, manifests, and container configurations.
- ImageMetadataTemplate(ManifestTemplate, List<ManifestAndConfigTemplate>) - Constructor for class com.google.cloud.tools.jib.image.json.ImageMetadataTemplate
- ImageReference - Class in com.google.cloud.tools.jib.api
-
Represents an image reference.
- ImageTarball - Class in com.google.cloud.tools.jib.image
-
Translates an
Image
to a tarball that can be loaded into Docker. - ImageTarball(Image, ImageReference, ImmutableSet<String>) - Constructor for class com.google.cloud.tools.jib.image.ImageTarball
-
Instantiate with an
Image
. - ImageToJsonTranslator - Class in com.google.cloud.tools.jib.image.json
-
Translates an
Image
into a manifest or container configuration JSON. - ImageToJsonTranslator(Image) - Constructor for class com.google.cloud.tools.jib.image.json.ImageToJsonTranslator
-
Instantiate with an
Image
. - info(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- INFO - com.google.cloud.tools.jib.api.LogEvent.Level
-
Details that can be ignored.
- InsecureRegistryException - Exception in com.google.cloud.tools.jib.api
-
Throw when attempting to access an insecure registry when only secure connections are allowed.
- InsecureRegistryException(URL, Throwable) - Constructor for exception com.google.cloud.tools.jib.api.InsecureRegistryException
-
Creates a new exception with a human readable message.
- inspect(ImageReference) - Method in interface com.google.cloud.tools.jib.api.DockerClient
-
Gets the size, image ID, and diff IDs of an image in the Docker daemon.
- inspect(ImageReference) - Method in class com.google.cloud.tools.jib.docker.CliDockerClient
- InvalidImageReferenceException - Exception in com.google.cloud.tools.jib.api
-
Thrown when attempting to parse an invalid image reference.
- InvalidImageReferenceException(String) - Constructor for exception com.google.cloud.tools.jib.api.InvalidImageReferenceException
- isDefaultDockerInstalled() - Static method in class com.google.cloud.tools.jib.docker.CliDockerClient
-
Checks if Docker is installed on the user's system by running the `docker` command.
- isDefaultTag(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Returns
true
iftag
is the default tag (latest
);false
if not. - isDockerInstalled(Path) - Static method in class com.google.cloud.tools.jib.docker.CliDockerClient
-
Checks if Docker is installed on the user's system and by verifying if the executable path provided has the appropriate permissions.
- isImagePushed() - Method in class com.google.cloud.tools.jib.api.JibContainer
-
Returns true if we pushed this image all the way to a registry.
- isImagePushed() - Method in class com.google.cloud.tools.jib.builder.steps.BuildResult
- isOAuth2RefreshToken() - Method in class com.google.cloud.tools.jib.api.Credential
-
Check whether this credential is an OAuth 2.0 refresh token.
- isOffline() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Gets whether or not to run the build in offline mode.
- isRetryable() - Method in interface com.google.cloud.tools.jib.blob.Blob
-
Whether
Blob.writeTo(OutputStream)
is retryable. - isScratch() - Method in class com.google.cloud.tools.jib.api.ImageReference
- isUserAgentEnabled() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets whether or not to enable the User-Agent header.
- isValidDigest(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Returns
true
ifdigest
is a valid digest string. - isValidRegistry(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Returns
true
ifregistry
is a valid registry string. - isValidRepository(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Returns
true
ifrepository
is a valid repository string. - isValidTag(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Returns
true
iftag
is a valid tag string.
J
- JavaContainerBuilder - Class in com.google.cloud.tools.jib.api
-
Creates a
JibContainerBuilder
for containerizing Java applications. - JavaContainerBuilder.LayerType - Enum in com.google.cloud.tools.jib.api
-
Represents the different types of layers for a Java application.
- 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.
- JibContainerDescription - Class in com.google.cloud.tools.jib.api
-
A class containing the representation of the contents of a container.
- JibEvent - Interface in com.google.cloud.tools.jib.api
-
Type for events dispatched by Jib Core.
- 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
- JVM_ARG_FILES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
K
- known(Credential, String) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetriever
that returns a knownCredential
.
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
. - LAP - com.google.cloud.tools.jib.event.events.TimerEvent.State
-
The timer timed a lap.
- Layer - Interface in com.google.cloud.tools.jib.image
-
Represents a layer in an image.
- LayerConfiguration - Class in com.google.cloud.tools.jib.api
-
Deprecated.Use
FileEntriesLayer
. - LayerConfiguration.Builder - Class in com.google.cloud.tools.jib.api
-
Deprecated.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.api
-
Deprecated.Use
FileEntry
. - LayerEntry(Path, AbsoluteUnixPath, FilePermissions, Instant) - Constructor for class com.google.cloud.tools.jib.api.LayerEntry
-
Deprecated.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.
- legacyDockerConfig(Path) - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetriever
that tries to retrieve credentials from a legacy Docker config file. - lifecycle(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- LIFECYCLE - com.google.cloud.tools.jib.api.LogEvent.Level
-
Default.
- load(ImageTarball, Consumer<Long>) - Method in interface com.google.cloud.tools.jib.api.DockerClient
-
Loads an image tarball into the Docker daemon.
- load(ImageTarball, Consumer<Long>) - Method in class com.google.cloud.tools.jib.docker.CliDockerClient
- LocalBaseImageSteps - Class in com.google.cloud.tools.jib.builder.steps
-
Extracts a tar file base image.
- lock(Path) - Static method in class com.google.cloud.tools.jib.filesystem.LockFile
-
Creates a lock file.
- LockFile - Class in com.google.cloud.tools.jib.filesystem
-
Creates and deletes lock files.
- LogEvent - Class in com.google.cloud.tools.jib.api
-
Log message event.
- LogEvent.Level - Enum in com.google.cloud.tools.jib.api
-
Log levels, in order of verbosity.
M
- MAIN_CLASS_FOUND - com.google.cloud.tools.jib.api.MainClassFinder.Result.Type
- MAIN_CLASS_NOT_FOUND - com.google.cloud.tools.jib.api.MainClassFinder.Result.Type
- MainClassFinder - Class in com.google.cloud.tools.jib.api
-
Finds main classes in a list of class files.
- MainClassFinder() - Constructor for class com.google.cloud.tools.jib.api.MainClassFinder
- MainClassFinder.Result - Class in com.google.cloud.tools.jib.api
- MainClassFinder.Result.Type - Enum in com.google.cloud.tools.jib.api
-
The type of result.
- 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.V22ManifestListTemplate
- MANIFEST_MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate
-
The Docker V2.2 manifest media type.
- ManifestAndConfigTemplate - Class in com.google.cloud.tools.jib.image.json
-
Stores a manifest and container config.
- ManifestAndConfigTemplate(ManifestTemplate, ContainerConfigurationTemplate) - Constructor for class com.google.cloud.tools.jib.image.json.ManifestAndConfigTemplate
-
Creates an instance.
- ManifestAndConfigTemplate(ManifestTemplate, ContainerConfigurationTemplate, String) - Constructor for class com.google.cloud.tools.jib.image.json.ManifestAndConfigTemplate
-
Creates an instance.
- ManifestAndDigest<T extends ManifestTemplate> - Class in com.google.cloud.tools.jib.registry
-
Stores a manifest and digest.
- ManifestAndDigest(T, DescriptorDigest) - Constructor for class com.google.cloud.tools.jib.registry.ManifestAndDigest
- ManifestDescriptorTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- ManifestListGenerator - Class in com.google.cloud.tools.jib.image.json
-
Generates a manifest list for
Image
s. - ManifestListGenerator(List<Image>) - Constructor for class com.google.cloud.tools.jib.image.json.ManifestListGenerator
- ManifestListTemplate - Interface in com.google.cloud.tools.jib.image.json
-
Parent class for manifest lists.
- ManifestTemplate - Interface in com.google.cloud.tools.jib.image.json
-
Parent class for image manifest and manifest list JSON templates.
- maximumRetries(int) - Method in class com.google.cloud.tools.jib.cache.Retry
-
Configure the maximum number of retries.
- MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.OciIndexTemplate
-
The OCI Index media type.
- MEDIA_TYPE - Static variable in class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
- MULTIPLE_MAIN_CLASSES - com.google.cloud.tools.jib.api.MainClassFinder.Result.Type
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(ImageReference) - Static method in class com.google.cloud.tools.jib.api.RegistryImage
-
Instantiate with the image reference to use.
- named(ImageReference) - Method in class com.google.cloud.tools.jib.api.TarImage
-
Sets the name of the image.
- 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(String) - Static method in class com.google.cloud.tools.jib.api.RegistryImage
-
Instantiate with the image reference to use.
- named(String) - Method in class com.google.cloud.tools.jib.api.TarImage
-
Sets the name of the image.
- newBaseImageRegistryClientFactory() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Creates a new
RegistryClient.Factory
for the base image with fields from the build configuration. - newBaseImageRegistryClientFactory(String) - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Creates a new
RegistryClient.Factory
for the base image repository on the registryserverUrl
. - newChild(String, long) - Method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Creates a new child
Allocation
(sub-allocation). - newChildProducer() - Method in class com.google.cloud.tools.jib.builder.ProgressEventDispatcher
-
Creates a new
ProgressEventDispatcher.Factory
for aProgressEventDispatcher
that manages a childAllocation
. - newDirectory() - Method in class com.google.cloud.tools.jib.filesystem.TempDirectoryProvider
-
Creates a new temporary directory.
- newDirectory(Path) - Method in class com.google.cloud.tools.jib.filesystem.TempDirectoryProvider
-
Creates a new temporary directory.
- newRegistryClient() - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory
-
Creates a new
RegistryClient
. - newRoot(EventHandlers, String, long) - Static method in class com.google.cloud.tools.jib.builder.ProgressEventDispatcher
-
Creates a new
ProgressEventDispatcher
with a rootAllocation
. - newRoot(String, long) - Static method in class com.google.cloud.tools.jib.event.progress.Allocation
-
Creates a new root
Allocation
. - newTargetImageRegistryClientFactory() - Method in class com.google.cloud.tools.jib.configuration.BuildContext
-
Creates a new
RegistryClient.Factory
for the target image with fields from the build configuration. - NONE - Static variable in class com.google.cloud.tools.jib.event.EventHandlers
-
An empty
EventHandlers
. - NotifyingOutputStream - Class in com.google.cloud.tools.jib.http
-
Counts the number of bytes written and reports the count to a callback.
- NotifyingOutputStream(OutputStream, Consumer<Long>) - Constructor for class com.google.cloud.tools.jib.http.NotifyingOutputStream
-
Wraps the
underlyingOutputStream
to count the bytes written.
O
- OAUTH2_TOKEN_USER_NAME - Static variable in class com.google.cloud.tools.jib.api.Credential
- OciIndexTemplate - Class in com.google.cloud.tools.jib.image.json
-
JSON template for OCI archive "index.json" file.
- OciIndexTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.OciIndexTemplate
- OciIndexTemplate.ManifestDescriptorTemplate - Class in com.google.cloud.tools.jib.image.json
-
Template for inner JSON object representing a single platform specific manifest.
- OciIndexTemplate.ManifestDescriptorTemplate.Platform - Class in com.google.cloud.tools.jib.image.json
- 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.api.ImageReference
-
Constructs an
ImageReference
from the image reference components, consisting of an optional registry, a repository, and an optional tag. - of(String, String, String, String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Constructs an
ImageReference
from the image reference components, consisting of an optional registry, a repository, an optional tag, and an optional digest.
P
- parse(String) - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Parses a string
reference
into anImageReference
. - parse(List<String>) - Static method in class com.google.cloud.tools.jib.api.Ports
-
Converts/validates a list of strings representing port ranges to an expanded list of
Port
s. - PathConsumer - Interface in com.google.cloud.tools.jib.filesystem
- Platform() - Constructor for class com.google.cloud.tools.jib.image.json.OciIndexTemplate.ManifestDescriptorTemplate.Platform
- Platform() - Constructor for class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate.Platform
- PlatformChecker - Class in com.google.cloud.tools.jib.builder.steps
-
Provides helper methods to check platforms.
- PlatformNotFoundInBaseImageException - Exception in com.google.cloud.tools.jib.image.json
-
Exception thrown when build target platforms are not found in the base image.
- PlatformNotFoundInBaseImageException(String) - Constructor for exception com.google.cloud.tools.jib.image.json.PlatformNotFoundInBaseImageException
- Ports - Class in com.google.cloud.tools.jib.api
-
Utility for parsing Docker/OCI ports from text representations.
- post(URL, Request) - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Sends the request with method POST.
- progress(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- PROGRESS - com.google.cloud.tools.jib.api.LogEvent.Level
-
Same as
LogEvent.Level.LIFECYCLE
, except represents progress updates. - ProgressEvent - Class in com.google.cloud.tools.jib.event.events
-
Event representing progress.
- ProgressEvent(Allocation, long) - Constructor for class com.google.cloud.tools.jib.event.events.ProgressEvent
- ProgressEventDispatcher - Class in com.google.cloud.tools.jib.builder
-
Dispatches
ProgressEvent
s associated with a managedAllocation
. - ProgressEventDispatcher.Factory - Interface in com.google.cloud.tools.jib.builder
-
Creates a new
ProgressEventDispatcher
based off an existingProgressEventDispatcher
. - ProgressEventHandler - Class in com.google.cloud.tools.jib.event.progress
-
Handles
ProgressEvent
s by accumulating an overall progress and keeping track of whichAllocation
s are complete. - ProgressEventHandler(Consumer<ProgressEventHandler.Update>) - Constructor for class com.google.cloud.tools.jib.event.progress.ProgressEventHandler
- ProgressEventHandler.Update - Class in com.google.cloud.tools.jib.event.progress
-
Contains the accumulated progress and which "leaf" tasks are not yet complete.
- PROJECT_DEPENDENCIES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- ProjectInfo - Class in com.google.cloud.tools.jib
-
Constants relating to the Jib project.
- pullBlob(DescriptorDigest, Consumer<Long>, Consumer<Long>) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Gets the BLOB referenced by
blobDigest
. - pullManifest(String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
- pullManifest(String, Class<T>) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Pulls the image manifest and digest for a specific tag.
- pushBlob(DescriptorDigest, Blob, String, Consumer<Long>) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Pushes the BLOB.
- pushManifest(ManifestTemplate, String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient
-
Pushes the image manifest for a specific tag.
- put(URL, Request) - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Sends the request with method PUT.
R
- readJson(byte[], Class<T>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
-
Deserializes a JSON object from a JSON byte array.
- readJson(InputStream, Class<T>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
-
Deserializes a JSON object from a JSON input stream.
- 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. - REGISTRY_IMAGE_PREFIX - Static variable in class com.google.cloud.tools.jib.api.Jib
- RegistryAliasGroup - Class in com.google.cloud.tools.jib.registry
-
Provides known aliases and alternative hosts for a given registry.
- RegistryAuthenticationFailedException - Exception in com.google.cloud.tools.jib.api
-
Thrown because registry authentication failed.
- RegistryAuthenticationFailedException(String, String, String) - Constructor for exception com.google.cloud.tools.jib.api.RegistryAuthenticationFailedException
-
Creates a new exception with a human readable message.
- RegistryAuthenticationFailedException(String, String, Throwable) - Constructor for exception com.google.cloud.tools.jib.api.RegistryAuthenticationFailedException
-
Creates a new exception with a human readable message.
- RegistryAuthenticator - Class in com.google.cloud.tools.jib.registry
-
Authenticates push/pull access with a registry service.
- 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
RegistryClient
s. - RegistryCredentialsNotSentException - Exception in com.google.cloud.tools.jib.registry
-
Thrown when registry request was unauthorized because credentials weren't sent.
- RegistryException - Exception in com.google.cloud.tools.jib.api
-
Thrown when interacting with a registry.
- RegistryException(String) - Constructor for exception com.google.cloud.tools.jib.api.RegistryException
- RegistryException(String, Throwable) - Constructor for exception com.google.cloud.tools.jib.api.RegistryException
- RegistryException(Throwable) - Constructor for exception com.google.cloud.tools.jib.api.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.
- registryPushSteps() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner
-
Add steps for pushing images to a remote registry.
- RegistryUnauthorizedException - Exception in com.google.cloud.tools.jib.api
-
Thrown when a registry request was unauthorized and therefore authentication is needed.
- RegistryUnauthorizedException(String, String, ResponseException) - Constructor for exception com.google.cloud.tools.jib.api.RegistryUnauthorizedException
-
Identifies the image registry and repository that denied access.
- ReproducibleLayerBuilder - Class in com.google.cloud.tools.jib.image
-
Builds a reproducible layer
Blob
from files. - ReproducibleLayerBuilder(ImmutableList<FileEntry>) - 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
- requestAuthorizationCleared() - Method in exception com.google.cloud.tools.jib.http.ResponseException
-
Returns whether the
Authorization
HTTP header was cleared (and thus not sent). - resolve(Map<String, String>) - Static method in class com.google.cloud.tools.jib.docker.DockerClientResolver
-
Look for supported DockerClient.
- RESOURCES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- Response - Class in com.google.cloud.tools.jib.http
-
Holds an HTTP response.
- ResponseException - Exception in com.google.cloud.tools.jib.http
-
Holds an HTTP response exception.
- retrieve() - Method in interface com.google.cloud.tools.jib.api.CredentialRetriever
-
Fetches the credentials.
- retrieve() - Method in class com.google.cloud.tools.jib.registry.credentials.DockerCredentialHelper
-
Calls the credential helper CLI.
- retrieve(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Retrieves the
CachedLayer
for the layer with digestlayerDigest
. - retrieve(ImmutableList<FileEntry>) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Retrieves the
CachedLayer
that was built from thelayerEntries
. - retrieve(Consumer<LogEvent>) - Method in class com.google.cloud.tools.jib.registry.credentials.DockerConfigCredentialRetriever
-
Retrieves credentials for a registry.
- retrieveLocalConfig(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Retrieves the
ContainerConfigurationTemplate
for the image saved from the given image ID. - retrieveMetadata(ImageReference) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Retrieves the cached image metadata (a manifest list and a list of manifest/container configuration pairs) for an image reference.
- retrieveTarLayer(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Retrieves a
CachedLayer
for a local base image layer with the given diff id. - Retry<E extends java.lang.Exception> - Class in com.google.cloud.tools.jib.cache
-
Retries an action until it succeeds, or has retried too often and failed.
- Retry.Action<E extends java.lang.Exception> - Interface in com.google.cloud.tools.jib.cache
-
A runnable action that may throw an exception of type
E
. - retryOnException(Predicate<Exception>) - Method in class com.google.cloud.tools.jib.cache.Retry
-
Provide a predicate to determine if a thrown exception can be retried.
- retrySupported() - Method in class com.google.cloud.tools.jib.http.BlobHttpContent
- run() - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner
-
Run all steps and return a BuildResult after a build is completed.
- run() - Method in interface com.google.cloud.tools.jib.cache.Retry.Action
-
Perform the action.
- run() - Method in class com.google.cloud.tools.jib.cache.Retry
-
Run the action until it runs successfully, to a
maximum number of retries
(default: 5).
S
- save(ImageReference, Path, Consumer<Long>) - Method in interface com.google.cloud.tools.jib.api.DockerClient
-
Saves an image tarball from the Docker daemon.
- save(ImageReference, Path, Consumer<Long>) - Method in class com.google.cloud.tools.jib.docker.CliDockerClient
- scratch() - Static method in class com.google.cloud.tools.jib.api.ImageReference
-
Constructs an
ImageReference
with an empty registry and tag component, and repository set to "scratch". - SEND_CREDENTIALS_OVER_HTTP - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties
- sendCredentialsOverHttp() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets whether or not to allow sending authentication information over insecure HTTP connections.
- serialize(DescriptorDigest, JsonGenerator, SerializerProvider) - Method in class com.google.cloud.tools.jib.image.json.DescriptorDigestSerializer
- SERIALIZE - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties
- serializeExecution() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets whether or not to serialize Jib's execution.
- 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.BuildContext.Builder
-
Sets the tags to tag the target image with (in addition to the tag in the target image configuration image reference set via
BuildContext.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.BuildContext.Builder
-
Sets whether or not to allow communication over HTTP (as opposed to HTTPS).
- setAlwaysCacheBaseImage(boolean) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Controls the optimization which skips downloading base image layers that exist in a target registry.
- setAlwaysCacheBaseImage(boolean) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Controls the optimization which skips downloading base image layers that exist in a target registry.
- 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.BuildContext.Builder
-
Sets the location of the cache for storing application layers.
- setAppRoot(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the app root of the container image (useful for building WAR containers).
- setAppRoot(String) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the app root of the container image (useful for building WAR containers).
- setArchitecture(String) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Sets the image architecture.
- setArchitecture(String) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets the architecture for which this container was built.
- 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. - setBaseImageConfiguration(ImageConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.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.BuildContext.Builder
-
Sets the location of the cache for storing base image layers.
- setBody(HttpContent) - Method in class com.google.cloud.tools.jib.http.Request.Builder
-
Sets the body and its corresponding
Content-Type
header. - setClassesDestination(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the destination directory of the classes added to the container (relative to the app root).
- setComment(String) - Method in class com.google.cloud.tools.jib.image.json.HistoryEntry.Builder
- setConfig(String) - Method in class com.google.cloud.tools.jib.docker.json.DockerManifestEntryTemplate
- setContainerCmd(List<String>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
- setContainerConfiguration(long, DescriptorDigest) - Method in interface com.google.cloud.tools.jib.image.json.BuildableManifestTemplate
-
Sets the content descriptor of the container configuration.
- setContainerConfiguration(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.OciManifestTemplate
- setContainerConfiguration(long, DescriptorDigest) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestTemplate
- setContainerConfiguration(ContainerConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets configuration parameters for the container.
- 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<String, String>>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
- setContainerHealthCheckInterval(Long) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets interval on HealthCheck, creates an empty HealthCheck object if necessary.
- setContainerHealthCheckRetries(Integer) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets retries on HealthCheck, creates an empty HealthCheck object if necessary.
- setContainerHealthCheckStartPeriod(Long) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets startPeriod on HealthCheck, creates an empty HealthCheck object if necessary.
- setContainerHealthCheckTest(List<String>) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets test on HealthCheck, creates an empty HealthCheck object if necessary.
- setContainerHealthCheckTimeout(Long) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets timeout on HealthCheck, creates an empty HealthCheck object if necessary.
- 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
- setContainerVolumes(Map<String, Map<String, 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(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.
- 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
- setCredential(Credential) - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory
-
Sets the authentication credentials to use to authenticate with the registry.
- setCredentialRetrievers(List<CredentialRetriever>) - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration.Builder
-
Sets the providers for registry credentials.
- setDependenciesDestination(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the destination directory of the dependencies added to the container (relative to the app root).
- setDigest(String) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- setDockerClient(DockerClient) - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration.Builder
-
Sets the Docker client to be used for Docker daemon base images.
- setDockerEnvironment(Map<String, String>) - Method in class com.google.cloud.tools.jib.api.DockerDaemonImage
-
Sets the additional environment variables to use when running
docker
. - 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
- setEnablePlatformTags(boolean) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets whether to automatically add architecture suffix to tags for platform-specific images when building multi-platform images.
- setEntries(List<LayerEntry>) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Sets entries for the layer.
- 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.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.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.
- setEventHandlers(EventHandlers) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the
EventHandlers
to dispatch events with. - 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.BuildContext.Builder
-
Sets the
ExecutorService
Jib executes on. - setExposedPorts(Port...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the ports to expose from the container.
- setExposedPorts(Set<Port>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the ports to expose from the container.
- setExposedPorts(Set<Port>) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Sets the container's exposed ports.
- setFileEntriesLayers(FileEntriesLayer...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the layers.
- setFileEntriesLayers(List<FileEntriesLayer>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the layers (defined by a list of
FileEntriesLayer
s). - setFormat(ImageFormat) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the format to build the container image as.
- setHealthCheck(DockerHealthCheck) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Sets the container's healthcheck configuration.
- setHttpTimeout(Integer) - Method in class com.google.cloud.tools.jib.http.Request.Builder
-
Sets the HTTP connection and read timeout in milliseconds.
- setInterval(Duration) - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck.Builder
-
Sets the time between healthchecks.
- 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.
- setLayerBlob(Blob) - Method in class com.google.cloud.tools.jib.cache.CachedLayer.Builder
- setLayerConfigurations(List<FileEntriesLayer>) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the layers to build.
- setLayerDiffId(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.CachedLayer.Builder
- setLayerDigest(DescriptorDigest) - Method in class com.google.cloud.tools.jib.cache.CachedLayer.Builder
- setLayers(LayerConfiguration...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Deprecated.
- setLayers(List<LayerConfiguration>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Deprecated.
- setLayerSize(long) - Method in class com.google.cloud.tools.jib.cache.CachedLayer.Builder
- setMainClass(String) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the container entrypoint with the specified main class.
- setMediaType(String) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- setModificationTimeProvider(ModificationTimeProvider) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the modification time provider for container files.
- setName(String) - Method in class com.google.cloud.tools.jib.api.LayerConfiguration.Builder
-
Deprecated.Sets a name for this layer.
- setOffline(boolean) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets whether or not to perform the build in offline mode.
- setOfflineMode(boolean) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Sets whether or not to run the build in offline mode.
- setOs(String) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Sets the image operating system.
- setOs(String) - Method in class com.google.cloud.tools.jib.image.json.ContainerConfigurationTemplate
-
Sets the operating system for which this container was built.
- setOthersDestination(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the destination directory of additional classpath files added to the container (relative to the app root).
- setPlatform(String, String) - Method in class com.google.cloud.tools.jib.image.json.OciIndexTemplate.ManifestDescriptorTemplate
-
Sets a platform.
- setPlatform(String, String) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
-
Sets a platform.
- setPlatforms(Set<Platform>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets a desired platform (properties including OS and architecture) list.
- setPlatforms(Set<Platform>) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Sets a desired platform (properties including OS and architecture) list.
- 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.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.image.Image.Builder
-
Sets the items in the "Cmd" field in the container configuration.
- setRegistryMirrors(ListMultimap<String, String>) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the registry mirrors.
- setResourcesDestination(RelativeUnixPath) - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Sets the destination directory of the resources added to the container (relative to the app root).
- setRetries(int) - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck.Builder
-
Sets the number of times to retry the healthcheck before the container is considered to be unhealthy.
- setSize(long) - Method in class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate.ManifestDescriptorTemplate
- setStartPeriod(Duration) - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck.Builder
-
Sets the initialization time to wait before using healthchecks.
- setTargetFormat(ImageFormat) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the target format of the container image.
- setTargetImageConfiguration(ImageConfiguration) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the target image configuration.
- setTarPath(Path) - Method in class com.google.cloud.tools.jib.configuration.ImageConfiguration.Builder
-
Sets the path for tarball base images.
- setTimeout(Duration) - Method in class com.google.cloud.tools.jib.configuration.DockerHealthCheck.Builder
-
Sets the time until a healthcheck is considered hung.
- 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.BuildContext.Builder
-
Sets the name of the tool that is executing the build.
- setToolVersion(String) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Sets the version of the tool that is using Jib Core.
- setToolVersion(String) - Method in class com.google.cloud.tools.jib.configuration.BuildContext.Builder
-
Sets the version 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.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. - setUserAgent(String) - Method in class com.google.cloud.tools.jib.registry.RegistryClient.Factory
-
Sets the value of
User-Agent
in headers for registry requests. - setVolumes(AbsoluteUnixPath...) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the directories that may hold externally mounted volumes.
- setVolumes(Set<AbsoluteUnixPath>) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the directories that may hold externally mounted volumes.
- setVolumes(Set<AbsoluteUnixPath>) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Sets the container's volumes.
- setWorkingDirectory(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Sets the working directory in the container.
- setWorkingDirectory(AbsoluteUnixPath) - Method in class com.google.cloud.tools.jib.configuration.ContainerConfiguration.Builder
-
Sets the working directory in the container.
- setWorkingDirectory(String) - Method in class com.google.cloud.tools.jib.image.Image.Builder
-
Sets the item in the "WorkingDir" field in the container configuration.
- shutDown() - Method in class com.google.cloud.tools.jib.http.FailoverHttpClient
-
Closes all connections and allocated resources, whether they are currently used or not.
- SKIP_EXISTING_IMAGES - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties
- skipExistingImages() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets whether or not to skip pushing tags to existing images.
- sleep(long, TimeUnit) - Method in class com.google.cloud.tools.jib.cache.Retry
-
Set the sleep time between retries.
- SNAPSHOT_DEPENDENCIES - com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
- START - com.google.cloud.tools.jib.event.events.TimerEvent.State
-
The timer has started timing.
- StepsRunner - Class in com.google.cloud.tools.jib.builder.steps
-
Runs steps for building an image.
- subTimer(String) - Method in class com.google.cloud.tools.jib.builder.TimerEventDispatcher
-
Creates a new
TimerEventDispatcher
with its parent timer as this. - supported(Map<String, String>) - Method in interface com.google.cloud.tools.jib.api.DockerClient
-
Validate if the DockerClient is supported.
- supported(Map<String, String>) - Method in class com.google.cloud.tools.jib.docker.CliDockerClient
T
- TAR_IMAGE_PREFIX - Static variable in class com.google.cloud.tools.jib.api.Jib
- tarBuildSteps(Path) - Method in class com.google.cloud.tools.jib.builder.steps.StepsRunner
-
Add steps for writing an image as a tar file archive.
- TarExtractor - Class in com.google.cloud.tools.jib.tar
-
Extracts a tarball.
- TarImage - Class in com.google.cloud.tools.jib.api
-
Builds to a tarball archive.
- TarStreamBuilder - Class in com.google.cloud.tools.jib.tar
-
Builds a tarball archive.
- TarStreamBuilder() - Constructor for class com.google.cloud.tools.jib.tar.TarStreamBuilder
- TempDirectoryProvider - Class in com.google.cloud.tools.jib.filesystem
-
Creates temporary directories and deletes them all when closed.
- TempDirectoryProvider() - Constructor for class com.google.cloud.tools.jib.filesystem.TempDirectoryProvider
- ThrottledAccumulatingConsumer - Class in com.google.cloud.tools.jib.event.progress
-
Wraps a
Consumer<Long>
so that multiple consume calls (ThrottledAccumulatingConsumer.accept(java.lang.Long)
) within a short period of time are merged into a single later call with the value accumulated up to that point. - ThrottledAccumulatingConsumer(Consumer<Long>) - Constructor for class com.google.cloud.tools.jib.event.progress.ThrottledAccumulatingConsumer
-
Wraps a consumer with the delay of 100 ms.
- ThrottledAccumulatingConsumer(Consumer<Long>, Duration, Supplier<Instant>) - Constructor for class com.google.cloud.tools.jib.event.progress.ThrottledAccumulatingConsumer
-
A new configured consumer.
- 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
Timer
s to dispatchTimerEvent
s. - TimerEventDispatcher(EventHandlers, String) - Constructor for class com.google.cloud.tools.jib.builder.TimerEventDispatcher
-
Creates a new
TimerEventDispatcher
. - to(DockerClient, DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer
-
Gets a new
Containerizer
that containerizes to a Docker daemon. - to(DockerDaemonImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer
-
Gets a new
Containerizer
that containerizes to a Docker daemon. - to(RegistryImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer
-
Gets a new
Containerizer
that containerizes to a container registry. - to(TarImage) - Static method in class com.google.cloud.tools.jib.api.Containerizer
-
Gets a new
Containerizer
that containerizes to a tarball archive. - toByteArray(JsonTemplate) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
- toByteArray(List<? extends JsonTemplate>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
- toContainerBuilder() - Method in class com.google.cloud.tools.jib.api.JavaContainerBuilder
-
Returns a new
JibContainerBuilder
using the parameters specified on theJavaContainerBuilder
. - toContainerBuildPlan() - Method in class com.google.cloud.tools.jib.api.JibContainerBuilder
-
Internal method.
- toImage(BuildableManifestTemplate, ContainerConfigurationTemplate) - Static method in class com.google.cloud.tools.jib.image.json.JsonToImageTranslator
-
Translates
BuildableManifestTemplate
toImage
. - toImage(V21ManifestTemplate) - Static method in class com.google.cloud.tools.jib.image.json.JsonToImageTranslator
-
Translates
V21ManifestTemplate
toImage
. - toString() - Method in class com.google.cloud.tools.jib.api.Credential
- toString() - Method in class com.google.cloud.tools.jib.api.DescriptorDigest
- toString() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Stringifies the
ImageReference
. - toString() - Method in class com.google.cloud.tools.jib.api.LogEvent
- toString() - Method in class com.google.cloud.tools.jib.blob.BlobDescriptor
- 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.json.HistoryEntry
- toStringWithQualifier() - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Stringifies the
ImageReference
. - toUtf8String(JsonTemplate) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
- toUtf8String(List<? extends JsonTemplate>) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
U
- 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
- UnlistedPlatformInManifestListException - Exception in com.google.cloud.tools.jib.image.json
-
Exception thrown when there is no matching platform in a manifest list.
- UnlistedPlatformInManifestListException(String) - Constructor for exception com.google.cloud.tools.jib.image.json.UnlistedPlatformInManifestListException
- UPSTREAM_CLIENT - Static variable in class com.google.cloud.tools.jib.global.JibSystemProperties
- useCrossRepositoryBlobMounts() - Static method in class com.google.cloud.tools.jib.global.JibSystemProperties
-
Gets whether or not to use cross-repository blob mounts when uploading image layers (
mount/from
). - usesDefaultTag() - Method in class com.google.cloud.tools.jib.api.ImageReference
V
- V21ManifestTemplate - Class in com.google.cloud.tools.jib.image.json
-
JSON template for Docker Manifest Schema V2.1
- V21ManifestTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.V21ManifestTemplate
- V22ManifestListTemplate - Class in com.google.cloud.tools.jib.image.json
-
JSON Template for Docker Manifest List Schema V2.2
- V22ManifestListTemplate() - Constructor for class com.google.cloud.tools.jib.image.json.V22ManifestListTemplate
- V22ManifestListTemplate.ManifestDescriptorTemplate - Class in com.google.cloud.tools.jib.image.json
-
Template for inner JSON object representing a single platform specific manifest.
- V22ManifestListTemplate.ManifestDescriptorTemplate.Platform - Class in com.google.cloud.tools.jib.image.json
- 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.api.JavaContainerBuilder.LayerType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.tools.jib.api.LogEvent.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.cloud.tools.jib.api.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.event.events.TimerEvent.State
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.cloud.tools.jib.api.JavaContainerBuilder.LayerType
-
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.api.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.api.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.event.events.TimerEvent.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- walk() - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker
-
Walks
DirectoryWalker.rootDir
. - walk(PathConsumer) - Method in class com.google.cloud.tools.jib.filesystem.DirectoryWalker
-
Walks
DirectoryWalker.rootDir
and appliespathConsumer
to each file. - warn(String) - Static method in class com.google.cloud.tools.jib.api.LogEvent
- WARN - com.google.cloud.tools.jib.api.LogEvent.Level
-
Something might not work as intended.
- wellKnownCredentialHelpers() - Method in class com.google.cloud.tools.jib.frontend.CredentialRetrieverFactory
-
Creates a new
CredentialRetriever
that tries well-known Docker credential helpers to retrieve credentials based on the registry of the image, such asdocker-credential-gcr
for images with the registry ending withgcr.io
. - withAdditionalTag(String) - Method in class com.google.cloud.tools.jib.api.Containerizer
-
Adds an additional tag to tag the target image with.
- withDirectory(Path) - Static method in class com.google.cloud.tools.jib.cache.Cache
-
Initializes the cache using
cacheDirectory
for storage. - withQualifier(String) - Method in class com.google.cloud.tools.jib.api.ImageReference
-
Gets an
ImageReference
with the same registry and repository, but a different tag or digest. - WritableContents - Interface in com.google.cloud.tools.jib.hash
-
As a function, writes some contents to an output stream.
- write(byte[]) - Method in class com.google.cloud.tools.jib.http.NotifyingOutputStream
- write(byte[], int, int) - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream
- write(byte[], int, int) - Method in class com.google.cloud.tools.jib.http.NotifyingOutputStream
- write(int) - Method in class com.google.cloud.tools.jib.hash.CountingDigestOutputStream
- write(int) - Method in class com.google.cloud.tools.jib.http.NotifyingOutputStream
- writeAsTarArchiveTo(OutputStream) - Method in class com.google.cloud.tools.jib.tar.TarStreamBuilder
-
Writes each entry in the filesystem to the tarball archive stream.
- writeCompressedLayer(Blob) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Saves a cache entry with a compressed layer
Blob
. - writeLocalConfig(DescriptorDigest, ContainerConfigurationTemplate) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Writes a container configuration to
(cache directory)/local/config/(image id)
. - writeMetadata(ImageReference, BuildableManifestTemplate, ContainerConfigurationTemplate) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Saves a schema 2 manifest for an image reference.
- writeMetadata(ImageReference, ImageMetadataTemplate) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Saves image metadata (a manifest list and a list of manifest/container configuration pairs) for an image reference.
- writeMetadata(ImageReference, V21ManifestTemplate) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Saves a V2.1 image manifest.
- WriteTarFileStep - Class in com.google.cloud.tools.jib.builder.steps
- writeTarLayer(DescriptorDigest, Blob) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Caches a layer that was extracted from a local base image, and names the file using the provided diff id.
- writeTo(JsonTemplate, OutputStream) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
- 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.hash.WritableContents
- writeTo(OutputStream) - Method in class com.google.cloud.tools.jib.http.BlobHttpContent
- writeTo(OutputStream) - Method in class com.google.cloud.tools.jib.image.ImageTarball
-
Writes image tar bar in configured
Image.getImageFormat()
of OCI or Docker to output stream. - writeTo(List<? extends JsonTemplate>, OutputStream) - Static method in class com.google.cloud.tools.jib.json.JsonTemplateMapper
- 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 with UTF-8 decoding.
- writeUncompressedLayer(Blob, ImmutableList<FileEntry>) - Method in class com.google.cloud.tools.jib.cache.Cache
-
Saves a cache entry with an uncompressed layer
Blob
and an additional selector digest.
X
- XdgDirectories - Class in com.google.cloud.tools.jib.filesystem
-
Obtains OS-specific directories based on the XDG Base Directory Specification.
All Classes All Packages