Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractBuildLog - Class in org.springframework.boot.buildpack.platform.build
-
Base class for
BuildLog
implementations. - AbstractBuildLog() - Constructor for class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- accept(TotalProgressEvent) - Method in class org.springframework.boot.buildpack.platform.docker.TotalProgressBar
- accept(T) - Method in interface org.springframework.boot.buildpack.platform.io.IOConsumer
-
Performs this operation on the given argument.
- accept(T, U) - Method in interface org.springframework.boot.buildpack.platform.io.IOBiConsumer
-
Performs this operation on the given argument.
- AF_LOCAL - Static variable in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- ALWAYS - Enum constant in enum class org.springframework.boot.buildpack.platform.build.PullPolicy
-
Always pull the image from the registry.
B
- basedOn(S, String, String, int) - Static method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
-
Factory method to create a new
VolumeName
based on an object. - basedOn(S, Function<S, String>, String, String, int) - Static method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
-
Factory method to create a new
VolumeName
based on an object. - Binding - Class in org.springframework.boot.buildpack.platform.docker.type
-
Volume bindings to apply when creating a container.
- build(BuildRequest) - Method in class org.springframework.boot.buildpack.platform.build.Builder
- Builder - Class in org.springframework.boot.buildpack.platform.build
-
Central API for running buildpack operations.
- Builder() - Constructor for class org.springframework.boot.buildpack.platform.build.Builder
-
Create a new builder instance.
- Builder(BuildLog) - Constructor for class org.springframework.boot.buildpack.platform.build.Builder
-
Create a new builder instance.
- Builder(BuildLog, DockerConfiguration) - Constructor for class org.springframework.boot.buildpack.platform.build.Builder
-
Create a new builder instance.
- Builder(DockerConfiguration) - Constructor for class org.springframework.boot.buildpack.platform.build.Builder
-
Create a new builder instance.
- BuilderException - Exception in org.springframework.boot.buildpack.platform.build
-
Exception thrown to indicate a Builder error.
- BuildLog - Interface in org.springframework.boot.buildpack.platform.build
-
Callback interface used to provide
Builder
output logging. - BuildpackReference - Class in org.springframework.boot.buildpack.platform.build
-
An opaque reference to a
Buildpack
. - BuildRequest - Class in org.springframework.boot.buildpack.platform.build
-
A build request to be handled by the
Builder
.
C
- Cache - Class in org.springframework.boot.buildpack.platform.build
-
Details of a cache for use by the CNB builder.
- Cache.Format - Enum Class in org.springframework.boot.buildpack.platform.build
-
The format of the cache.
- Cache.Volume - Class in org.springframework.boot.buildpack.platform.build
-
Details of a cache stored in a Docker volume.
- close() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- close() - Method in class org.springframework.boot.buildpack.platform.socket.NamedPipeSocket
- connect(String, int) - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- connect(SocketAddress) - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- connect(SocketAddress, int) - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- container() - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi
-
Return the Docker API for container operations.
- ContainerConfig - Class in org.springframework.boot.buildpack.platform.docker.type
-
Configuration used when creating a new container.
- ContainerConfig.Update - Class in org.springframework.boot.buildpack.platform.docker.type
-
Update class used to change data when creating a container config.
- ContainerContent - Interface in org.springframework.boot.buildpack.platform.docker.type
-
Additional content that can be written to a created container.
- ContainerReference - Class in org.springframework.boot.buildpack.platform.docker.type
-
A reference to a Docker container.
- ContainerStatus - Class in org.springframework.boot.buildpack.platform.docker.type
-
Status details returned from
Docker container wait
. - Content - Interface in org.springframework.boot.buildpack.platform.io
-
Content with a known size that can be written to an
OutputStream
. - copy(Consumer<ImageConfig.Update>) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageConfig
-
Create an updated copy of this image config.
- create(DockerHost) - Static method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Create the most suitable
HttpTransport
based on theDockerHost
. - create(ContainerConfig, ContainerContent...) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
-
Create a new container a
ContainerConfig
. - Creator - Class in org.springframework.boot.buildpack.platform.build
-
Identifying information about the tooling that created a builder.
D
- delete(URI) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP DELETE operation.
- delete(VolumeName, boolean) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.VolumeApi
-
Delete a volume.
- directory(String, Owner) - Method in interface org.springframework.boot.buildpack.platform.io.Layout
-
Add a directory to the content.
- directory(String, Owner, int) - Method in interface org.springframework.boot.buildpack.platform.io.Layout
-
Add a directory to the content.
- DockerApi - Class in org.springframework.boot.buildpack.platform.docker
-
Provides access to the limited set of Docker APIs needed by pack.
- DockerApi() - Constructor for class org.springframework.boot.buildpack.platform.docker.DockerApi
-
Create a new
DockerApi
instance. - DockerApi(DockerHost) - Constructor for class org.springframework.boot.buildpack.platform.docker.DockerApi
-
Create a new
DockerApi
instance. - DockerApi.ContainerApi - Class in org.springframework.boot.buildpack.platform.docker
-
Docker API for container operations.
- DockerApi.ImageApi - Class in org.springframework.boot.buildpack.platform.docker
-
Docker API for image operations.
- DockerApi.VolumeApi - Class in org.springframework.boot.buildpack.platform.docker
-
Docker API for volume operations.
- DockerConfiguration - Class in org.springframework.boot.buildpack.platform.docker.configuration
-
Docker configuration options.
- DockerConfiguration() - Constructor for class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- DockerConnectionException - Exception in org.springframework.boot.buildpack.platform.docker.transport
-
Exception thrown when connection to the Docker daemon fails.
- DockerConnectionException(String, Exception) - Constructor for exception org.springframework.boot.buildpack.platform.docker.transport.DockerConnectionException
- DockerEngineException - Exception in org.springframework.boot.buildpack.platform.docker.transport
-
Exception thrown when a call to the Docker API fails.
- DockerEngineException(String, URI, int, String, Errors, Message) - Constructor for exception org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException
- DockerHost - Class in org.springframework.boot.buildpack.platform.docker.configuration
-
Docker host connection options.
- DockerHost(String) - Constructor for class org.springframework.boot.buildpack.platform.docker.configuration.DockerHost
- DockerHost(String, boolean, String) - Constructor for class org.springframework.boot.buildpack.platform.docker.configuration.DockerHost
- DockerRegistryAuthentication - Interface in org.springframework.boot.buildpack.platform.docker.configuration
-
Docker registry authentication configuration.
- DomainSocket - Class in org.springframework.boot.buildpack.platform.socket
-
A
Socket
implementation for Linux of BSD domain sockets.
E
- Environment - Interface in org.springframework.boot.buildpack.platform.system
-
Provides access to environment variable values.
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.build.BuildpackReference
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.build.Cache
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.build.Cache.Volume
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.Binding
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerReference
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
- equals(Object) - Method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
- ErrorDetail(String) - Constructor for class org.springframework.boot.buildpack.platform.docker.PushImageUpdateEvent.ErrorDetail
- Errors - Class in org.springframework.boot.buildpack.platform.docker.transport
-
Errors returned from the Docker API.
- Errors.Error - Class in org.springframework.boot.buildpack.platform.docker.transport
-
An individual Docker error.
- executedLifecycle(BuildRequest) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- executedLifecycle(BuildRequest) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that the lifecycle has executed.
- executingLifecycle(BuildRequest, LifecycleVersion, VolumeName) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- executingLifecycle(BuildRequest, LifecycleVersion, VolumeName) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that the lifecycle is executing.
- exportLayerFiles(ImageReference, IOBiConsumer<String, Path>) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Export the layers of an image as paths to layer tar files.
- exportLayers(ImageReference, IOBiConsumer<String, TarArchive>) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Export the layers of an image as
TarArchive
s.
F
- file(String, Owner, int, Content) - Method in interface org.springframework.boot.buildpack.platform.io.Layout
-
Write a file to the content.
- file(String, Owner, Content) - Method in interface org.springframework.boot.buildpack.platform.io.Layout
-
Write a file to the content.
- FilePermissions - Class in org.springframework.boot.buildpack.platform.io
-
Utilities for dealing with file permissions and attributes.
- forDirectory(String) - Method in class org.springframework.boot.buildpack.platform.docker.ssl.SslContextFactory
-
Create an
SSLContext
from files in the specified directory. - forJarFile(File) - Static method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Factory method to create a new
BuildRequest
from a JAR file. - forJarFile(File) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
instance deduced from a source JAR file that follows common Java naming conventions. - forJarFile(ImageReference, File) - Static method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Factory method to create a new
BuildRequest
from a JAR file. - format - Variable in class org.springframework.boot.buildpack.platform.build.Cache
- from(String, String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Binding
-
Create a
Binding
from the specified source and destination. - from(DockerHost) - Static method in class org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost
- from(Image) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
-
Create a new
ImageArchive
based on an existingImage
. - from(Image, IOConsumer<ImageArchive.Update>) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
-
Create a new
ImageArchive
based on an existingImage
. - from(VolumeName, String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Binding
-
Create a
Binding
from the specified source and destination. - fromTarArchive(TarArchive) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Layer
-
Factory method to create a new
Layer
from aTarArchive
. - fromZip(File, Owner) - Static method in interface org.springframework.boot.buildpack.platform.io.TarArchive
-
Factory method to adapt a ZIP file to
TarArchive
.
G
- get() - Method in interface org.springframework.boot.buildpack.platform.io.IOSupplier
-
Gets the supplied value.
- get() - Static method in class org.springframework.boot.buildpack.platform.json.SharedObjectMapper
- get(InputStream, Class<T>, Consumer<T>) - Method in class org.springframework.boot.buildpack.platform.json.JsonStream
-
Stream objects from the content as they become available.
- get(InputStream, Consumer<ObjectNode>) - Method in class org.springframework.boot.buildpack.platform.json.JsonStream
-
Stream
object nodes
from the content as they become available. - get(String) - Static method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
-
Return a new
DomainSocket
for the given path. - get(String) - Static method in class org.springframework.boot.buildpack.platform.socket.NamedPipeSocket
-
Return a new
NamedPipeSocket
for the given path. - get(String) - Method in interface org.springframework.boot.buildpack.platform.system.Environment
-
Gets the value of the specified environment variable.
- get(URI) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP GET operation.
- getAddress() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerHost
- getAddress() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost
- getAlgorithm() - Method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
-
Return the algorithm of layer.
- getApplicationContent(Owner) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a
TarArchive
containing the application content that the buildpack should package. - getApplicationDirectory() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the application directory that should be used by the lifecycle.
- getArchive() - Method in interface org.springframework.boot.buildpack.platform.docker.type.ContainerContent
-
Return the actual content to be added.
- getAuthHeader() - Method in interface org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryAuthentication
-
Returns the auth header that should be used for docker authentication.
- getBindings() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the collection of bindings to mount to the build container.
- getBuildCache() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the custom build cache that should be used by the lifecycle.
- getBuilder() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the builder that should be used.
- getBuilderRegistryAuthentication() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- getBuildpacks() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the collection of buildpacks to use when building the image, if provided.
- getCertificatePath() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerHost
- getCode() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors.Error
-
Return the error code.
- getConfig() - Method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Return image config information.
- getContent() - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport.Response
-
Return the content of the response.
- getCreated() - Method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Return the created date of the image.
- getCreateDate() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
-
Return the create date of the archive.
- getCreatedDate() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the custom created date that should be used by the lifecycle.
- getCreator() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the
Creator
the builder should use. - getCurrent() - Method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent.ProgressDetail
-
Return the current progress value.
- getDestinationPath() - Method in interface org.springframework.boot.buildpack.platform.docker.type.ContainerContent
-
Return the destination path where the content should be added.
- getDigest() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return the digest from the reference or
null
. - getDigests() - Method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Return the digests of the image.
- getDomain() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
-
Return the domain for this image name.
- getDomain() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return the domain for this image name.
- getEntries() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchiveManifest
-
Return the entries contained in the manifest.
- getEnv() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return any env variable that should be passed to the builder.
- getEnv() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageConfig
-
Return the image environment variables.
- getErrorDetail() - Method in class org.springframework.boot.buildpack.platform.docker.PushImageUpdateEvent
-
Returns the details of any error encountered during processing.
- getErrors() - Method in exception org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException
-
Return the errors from the body of the Docker API response, or
null
if the errors JSON could not be read. - getGid() - Method in interface org.springframework.boot.buildpack.platform.io.Owner
-
Return the group identifier (GID) of the owner.
- getHash() - Method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
-
Return the hash of the layer.
- getHost() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- getId() - Method in class org.springframework.boot.buildpack.platform.docker.ImageProgressUpdateEvent
-
Returns the ID of the image layer being updated if available.
- getId() - Method in class org.springframework.boot.buildpack.platform.docker.type.Layer
-
Return the ID of the layer.
- getImageConfig() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
-
Return the image config for the archive.
- getInetAddress() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getInputStream() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getInputStream() - Method in class org.springframework.boot.buildpack.platform.socket.NamedPipeSocket
- getLabels() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageConfig
-
Return the image labels.
- getLaunchCache() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the custom launch cache that should be used by the lifecycle.
- getLayers() - Method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Return the layer IDs contained in the image.
- getLayers() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchiveManifest.ManifestEntry
-
Return the collection of layer IDs from a section of the manifest.
- getLocalAddress() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getLocalSocketAddress() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getMessage() - Method in class org.springframework.boot.buildpack.platform.docker.PushImageUpdateEvent.ErrorDetail
-
Returns the message field from the error detail.
- getMessage() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors.Error
-
Return the error message.
- getMessage() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Message
-
Return the message contained in the response.
- getName() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the name of the image that should be created.
- getName() - Method in class org.springframework.boot.buildpack.platform.build.Cache.Volume
- getName() - Method in class org.springframework.boot.buildpack.platform.build.Creator
-
Return the name of the builder creator.
- getName() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
-
Return the name of this image.
- getName() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return the name of this image.
- getNetwork() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the network the build container will connect to.
- getNode() - Method in class org.springframework.boot.buildpack.platform.json.MappedObject
-
Return the source node of the mapped object.
- getOperation() - Method in exception org.springframework.boot.buildpack.platform.build.BuilderException
-
Return the Builder operation that failed.
- getOs() - Method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Return the OS of the image.
- getOutputStream() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getOutputStream() - Method in class org.springframework.boot.buildpack.platform.socket.NamedPipeSocket
- getPayload() - Method in class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent
- getPercent() - Method in class org.springframework.boot.buildpack.platform.docker.TotalProgressEvent
-
Return the total progress.
- getProgress() - Method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent
-
Return a text based progress bar if progress information is available.
- getProgressConsumer(String) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- getProgressDetail() - Method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent
-
Return progress details if available.
- getPublishRegistryAuthentication() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- getPullPolicy() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the image
PullPolicy
that the builder should use. - getReasonPhrase() - Method in exception org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException
-
Return the reason phrase returned by the Docker API.
- getRemoteSocketAddress() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- getResponseMessage() - Method in exception org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException
-
Return the message from the body of the Docker API response, or
null
if the message JSON could not be read. - getRoot(Object) - Static method in class org.springframework.boot.buildpack.platform.json.MappedObject
- getRunImage() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the run image that should be used, if provided.
- getStatus() - Method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent
-
Return the status for the update.
- getStatusCode() - Method in exception org.springframework.boot.buildpack.platform.build.BuilderException
-
Return the status code returned from a Builder operation.
- getStatusCode() - Method in exception org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException
-
Return the status code returned by the Docker API.
- getStatusCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerStatus
-
Return the container exit status code.
- getStream() - Method in class org.springframework.boot.buildpack.platform.docker.LoadImageUpdateEvent
-
Return the stream response or
null
if no response is available. - getStreamType() - Method in class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent
- getTag() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
-
Return the tag of the archive.
- getTag() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return the tag from the reference or
null
. - getTags() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return the collection of tags that should be created.
- getTotal() - Method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent.ProgressDetail
-
Return the total progress possible value.
- getUid() - Method in interface org.springframework.boot.buildpack.platform.io.Owner
-
Return the user identifier (UID) of the owner.
- getVersion() - Method in class org.springframework.boot.buildpack.platform.build.Creator
-
Return the version of the builder creator.
- getVolume() - Method in class org.springframework.boot.buildpack.platform.build.Cache
-
Return the details of the cache if it is a volume cache.
- getWaitingErrorMessage() - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerStatus
-
Return a message indicating an error waiting for a container to stop.
H
- hashCode() - Method in class org.springframework.boot.buildpack.platform.build.BuildpackReference
- hashCode() - Method in class org.springframework.boot.buildpack.platform.build.Cache
- hashCode() - Method in class org.springframework.boot.buildpack.platform.build.Cache.Volume
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.Binding
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerReference
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
- hashCode() - Method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
- HttpTransport - Interface in org.springframework.boot.buildpack.platform.docker.transport
-
HTTP transport used for docker access.
- HttpTransport.Response - Interface in org.springframework.boot.buildpack.platform.docker.transport
-
An HTTP operation response.
I
- IF_NOT_PRESENT - Enum constant in enum class org.springframework.boot.buildpack.platform.build.PullPolicy
-
Pull the image from the registry only if it does not exist locally.
- image() - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi
-
Return the Docker API for image operations.
- Image - Class in org.springframework.boot.buildpack.platform.docker.type
-
Image details as returned from
Docker inspect
. - ImageArchive - Class in org.springframework.boot.buildpack.platform.docker.type
-
An image archive that can be loaded into Docker.
- ImageArchive.Update - Class in org.springframework.boot.buildpack.platform.docker.type
-
Update class used to change data when creating an image archive.
- ImageArchiveManifest - Class in org.springframework.boot.buildpack.platform.docker.type
-
Image archive manifest information.
- ImageArchiveManifest(JsonNode) - Constructor for class org.springframework.boot.buildpack.platform.docker.type.ImageArchiveManifest
- ImageArchiveManifest.ManifestEntry - Class in org.springframework.boot.buildpack.platform.docker.type
- ImageConfig - Class in org.springframework.boot.buildpack.platform.docker.type
-
Image configuration information.
- ImageConfig.Update - Class in org.springframework.boot.buildpack.platform.docker.type
-
Update class used to change data when creating a copy.
- ImageName - Class in org.springframework.boot.buildpack.platform.docker.type
-
A Docker image name of the form "docker.io/library/ubuntu".
- ImageProgressUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
A
ProgressUpdateEvent
fired for image events. - ImageProgressUpdateEvent(String, String, ProgressUpdateEvent.ProgressDetail, String) - Constructor for class org.springframework.boot.buildpack.platform.docker.ImageProgressUpdateEvent
- ImageReference - Class in org.springframework.boot.buildpack.platform.docker.type
-
A reference to a Docker image of the form
"imagename[:tag|@digest]"
. - inspect(ImageReference) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Inspect an image.
- InspectedContent - Class in org.springframework.boot.buildpack.platform.io
-
Content
that is reads and inspects a source of data only once but allows it to be consumed multiple times. - InspectedContent.Inspector - Interface in org.springframework.boot.buildpack.platform.io
-
Interface that can be used to inspect content as it is initially read.
- inTaggedForm() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return an
ImageReference
in the form"imagename:tag"
. - inTaggedOrDigestForm() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return an
ImageReference
containing either a tag or a digest. - inTaglessForm() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Return an
ImageReference
without the tag. - IOBiConsumer<T,
U> - Interface in org.springframework.boot.buildpack.platform.io -
BiConsumer that can safely throw
IO exceptions
. - IOConsumer<T> - Interface in org.springframework.boot.buildpack.platform.io
-
Consumer that can safely throw
IO exceptions
. - IOSupplier<T> - Interface in org.springframework.boot.buildpack.platform.io
-
Supplier that can safely throw
IO exceptions
. - isBindHostToBuilder() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- isBound() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- isCleanCache() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return if caches should be cleaned before packaging.
- isConnected() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- isEmpty() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors
-
Return if there are any contained errors.
- isEmpty(ProgressUpdateEvent.ProgressDetail) - Static method in class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent.ProgressDetail
- isLocalFileReference() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost
- isPublish() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return if the built image should be pushed to a registry.
- isRemote() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.ResolvedDockerHost
- isSecure() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerHost
- isVerboseLogging() - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return if verbose logging output should be used.
- iterator() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors
J
- JsonStream - Class in org.springframework.boot.buildpack.platform.json
-
Utility class that allows JSON to be parsed and processed as it's received.
- JsonStream(ObjectMapper) - Constructor for class org.springframework.boot.buildpack.platform.json.JsonStream
-
Create a new
JsonStream
backed by the given object mapper.
L
- Layer - Class in org.springframework.boot.buildpack.platform.docker.type
-
A layer that can be written to an
ImageArchive
. - LayerId - Class in org.springframework.boot.buildpack.platform.docker.type
-
A layer ID as used inside a Docker image of the form
algorithm: hash
. - Layout - Interface in org.springframework.boot.buildpack.platform.io
-
Interface that can be used to write a file/directory layout.
- load(ImageArchive, UpdateListener<LoadImageUpdateEvent>) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Load an
ImageArchive
into Docker. - LoadImageUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
A
ProgressUpdateEvent
fired as an image is loaded. - LoadImageUpdateEvent(String, String, ProgressUpdateEvent.ProgressDetail, String) - Constructor for class org.springframework.boot.buildpack.platform.docker.LoadImageUpdateEvent
- log() - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- log(String) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- logs(ContainerReference, UpdateListener<LogUpdateEvent>) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
-
Return and follow logs for a specific container.
- LogUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
An update event used to provide log updates.
- LogUpdateEvent.StreamType - Enum Class in org.springframework.boot.buildpack.platform.docker
-
Stream types supported by the event.
M
- ManifestEntry(JsonNode) - Constructor for class org.springframework.boot.buildpack.platform.docker.type.ImageArchiveManifest.ManifestEntry
- MappedObject - Class in org.springframework.boot.buildpack.platform.json
-
Base class for mapped JSON objects.
- MappedObject(JsonNode, MethodHandles.Lookup) - Constructor for class org.springframework.boot.buildpack.platform.json.MappedObject
-
Create a new
MappedObject
instance. - MappedObject.ContentReader<C> - Interface in org.springframework.boot.buildpack.platform.json
-
Strategy used to read JSON content.
- Message - Class in org.springframework.boot.buildpack.platform.docker.transport
-
A message returned from the Docker API.
N
- NamedPipeSocket - Class in org.springframework.boot.buildpack.platform.socket
-
A
Socket
implementation for named pipes. - NEVER - Enum constant in enum class org.springframework.boot.buildpack.platform.build.PullPolicy
-
Never pull the image from the registry.
- none() - Static method in interface org.springframework.boot.buildpack.platform.docker.UpdateListener
-
A no-op update listener that does nothing.
- NONE - Static variable in interface org.springframework.boot.buildpack.platform.docker.UpdateListener
-
A no-op update listener.
- NORMALIZED_TIME - Static variable in interface org.springframework.boot.buildpack.platform.io.TarArchive
-
Instant
that can be used to normalize TAR files so all entries have the same modification time.
O
- of(byte[]) - Static method in interface org.springframework.boot.buildpack.platform.io.Content
-
Create a new
Content
from the given input stream. - of(int, String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ContainerStatus
-
Create a new
ContainerStatus
instance with the specified values. - of(int, IOSupplier<InputStream>) - Static method in interface org.springframework.boot.buildpack.platform.io.Content
-
Create a new
Content
from the given input stream. - of(long, long) - Static method in interface org.springframework.boot.buildpack.platform.io.Owner
-
Factory method to create a new
Owner
with specified user/group identifier. - of(C, MappedObject.ContentReader<C>, Function<JsonNode, T>) - Static method in class org.springframework.boot.buildpack.platform.json.MappedObject
-
Factory method to create a new
MappedObject
instance. - of(File) - Static method in interface org.springframework.boot.buildpack.platform.io.Content
-
Create a new
Content
from the given file. - of(InputStream) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ContainerStatus
-
Create a new
ContainerStatus
instance from the specified JSON content stream. - of(InputStream) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Image
-
Create a new
Image
instance from the specified JSON content. - of(InputStream) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchiveManifest
-
Create an
ImageArchiveManifest
from the provided JSON input stream. - of(InputStream, Function<JsonNode, T>) - Static method in class org.springframework.boot.buildpack.platform.json.MappedObject
-
Factory method to create a new
MappedObject
instance. - of(InputStream, InspectedContent.Inspector...) - Static method in class org.springframework.boot.buildpack.platform.io.InspectedContent
-
Factory method to create an
InspectedContent
instance from a source input stream. - of(String) - Static method in class org.springframework.boot.buildpack.platform.build.BuildpackReference
-
Create a new
BuildpackReference
from the given value. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Binding
-
Create a
Binding
with the specified value containing a host source, container destination, and options. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ContainerReference
-
Factory method to create a
ContainerReference
with a specific value. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
-
Create a new
ImageName
from the given value. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
from the given value. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
-
Create a new
LayerId
with the specified value. - of(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
-
Factory method to create a
VolumeName
with a specific value. - of(String) - Static method in interface org.springframework.boot.buildpack.platform.io.Content
-
Create a new
Content
from the given UTF-8 string. - of(String, Function<JsonNode, T>) - Static method in class org.springframework.boot.buildpack.platform.json.MappedObject
-
Factory method to create a new
MappedObject
instance. - of(ImageName) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
from the givenImageName
. - of(ImageName, String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
from the givenImageName
and tag. - of(ImageName, String, String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
from the givenImageName
, tag and digest. - of(ImageReference, Consumer<ContainerConfig.Update>) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig
-
Factory method to create a
ContainerConfig
with specific settings. - of(ImageReference, Function<Owner, TarArchive>) - Static method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Factory method to create a new
BuildRequest
with specific content. - of(Content, InspectedContent.Inspector...) - Static method in class org.springframework.boot.buildpack.platform.io.InspectedContent
-
Factory method to create an
InspectedContent
instance from source content. - of(IOConsumer<OutputStream>, InspectedContent.Inspector...) - Static method in class org.springframework.boot.buildpack.platform.io.InspectedContent
-
Factory method to create an
InspectedContent
instance from a source write method. - of(IOConsumer<Layout>) - Static method in class org.springframework.boot.buildpack.platform.docker.type.Layer
- of(IOConsumer<Layout>) - Static method in interface org.springframework.boot.buildpack.platform.io.TarArchive
-
Factory method to create a new
TarArchive
instance with a specific layout. - of(TarArchive) - Static method in interface org.springframework.boot.buildpack.platform.docker.type.ContainerContent
-
Factory method to create a new
ContainerContent
instance written to the root of the container. - of(TarArchive, String) - Static method in interface org.springframework.boot.buildpack.platform.docker.type.ContainerContent
-
Factory method to create a new
ContainerContent
instance. - ofSha256Digest(byte[]) - Static method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
-
Create a new
LayerId
from a SHA-256 digest. - onFinish() - Method in class org.springframework.boot.buildpack.platform.docker.TotalProgressListener
- onFinish() - Method in interface org.springframework.boot.buildpack.platform.docker.UpdateListener
-
Called when the operation finishes (with or without error).
- onStart() - Method in class org.springframework.boot.buildpack.platform.docker.TotalProgressListener
- onStart() - Method in interface org.springframework.boot.buildpack.platform.docker.UpdateListener
-
Called when the operation starts.
- onUpdate(E) - Method in class org.springframework.boot.buildpack.platform.docker.TotalProgressListener
- onUpdate(E) - Method in interface org.springframework.boot.buildpack.platform.docker.UpdateListener
-
Called when an update event is available.
- org.springframework.boot.buildpack.platform.build - package org.springframework.boot.buildpack.platform.build
-
Central API for performing a buildpack build.
- org.springframework.boot.buildpack.platform.docker - package org.springframework.boot.buildpack.platform.docker
-
A limited Docker API providing the operations needed by pack.
- org.springframework.boot.buildpack.platform.docker.configuration - package org.springframework.boot.buildpack.platform.docker.configuration
-
Docker configuration options.
- org.springframework.boot.buildpack.platform.docker.ssl - package org.springframework.boot.buildpack.platform.docker.ssl
-
Utilities and classes for managing SSL context and keys.
- org.springframework.boot.buildpack.platform.docker.transport - package org.springframework.boot.buildpack.platform.docker.transport
-
Docker transport classes providing HTTP operations on a local or remote engine.
- org.springframework.boot.buildpack.platform.docker.type - package org.springframework.boot.buildpack.platform.docker.type
-
Docker types.
- org.springframework.boot.buildpack.platform.io - package org.springframework.boot.buildpack.platform.io
-
IO classes and utilities.
- org.springframework.boot.buildpack.platform.json - package org.springframework.boot.buildpack.platform.json
-
Utilities and classes for JSON processing.
- org.springframework.boot.buildpack.platform.socket - package org.springframework.boot.buildpack.platform.socket
-
Low-level
Socket
implementations required for local Docker access. - org.springframework.boot.buildpack.platform.system - package org.springframework.boot.buildpack.platform.system
-
System abstractions.
- Owner - Interface in org.springframework.boot.buildpack.platform.io
-
A user and group ID that can be used to indicate file ownership.
P
- PF_LOCAL - Static variable in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- posixPermissionsToUmask(Collection<PosixFilePermission>) - Static method in class org.springframework.boot.buildpack.platform.io.FilePermissions
-
Return the integer representation of a set of Posix file permissions, where the integer value conforms to the umask octal notation.
- post(URI) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP POST operation.
- post(URI, String) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP POST operation.
- post(URI, String, IOConsumer<OutputStream>) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP POST operation.
- print() - Method in class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent
- ProgressDetail(Integer, Integer) - Constructor for class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent.ProgressDetail
- ProgressUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
An
UpdateEvent
that includes progress information. - ProgressUpdateEvent(String, ProgressUpdateEvent.ProgressDetail, String) - Constructor for class org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent
- ProgressUpdateEvent.ProgressDetail - Class in org.springframework.boot.buildpack.platform.docker
-
Provide details about the progress of a task.
- pull(ImageReference, UpdateListener<PullImageUpdateEvent>) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Pull an image from a registry.
- pull(ImageReference, UpdateListener<PullImageUpdateEvent>, String) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Pull an image from a registry.
- pulledImage(Image, ImageType) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- pulledImage(Image, ImageType) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that an image has been pulled.
- PullImageUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
A
ProgressUpdateEvent
fired as an image is pulled. - PullImageUpdateEvent(String, String, ProgressUpdateEvent.ProgressDetail, String) - Constructor for class org.springframework.boot.buildpack.platform.docker.PullImageUpdateEvent
- pullingImage(ImageReference, ImageType) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- pullingImage(ImageReference, ImageType) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that an image is being pulled.
- PullPolicy - Enum Class in org.springframework.boot.buildpack.platform.build
-
Image pull policy.
- push(ImageReference, UpdateListener<PushImageUpdateEvent>, String) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Push an image to a registry.
- pushedImage(ImageReference) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- pushedImage(ImageReference) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that an image has been pushed.
- PushImageUpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
A
ProgressUpdateEvent
fired as an image is pushed to a registry. - PushImageUpdateEvent(String, String, ProgressUpdateEvent.ProgressDetail, String, PushImageUpdateEvent.ErrorDetail) - Constructor for class org.springframework.boot.buildpack.platform.docker.PushImageUpdateEvent
- PushImageUpdateEvent.ErrorDetail - Class in org.springframework.boot.buildpack.platform.docker
-
Details of an error embedded in a response stream.
- pushingImage(ImageReference) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- pushingImage(ImageReference) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that an image is being pushed.
- put(URI, String, IOConsumer<OutputStream>) - Method in interface org.springframework.boot.buildpack.platform.docker.transport.HttpTransport
-
Perform an HTTP PUT operation.
R
- random(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Generate an image name with a random suffix.
- random(String) - Static method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
-
Factory method to create a new
VolumeName
with a random name. - random(String, int) - Static method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Generate an image name with a random suffix.
- random(String, int) - Static method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
-
Factory method to create a new
VolumeName
with a random name. - read(ObjectMapper, C) - Method in interface org.springframework.boot.buildpack.platform.json.MappedObject.ContentReader
-
Read JSON content as a
JsonNode
. - remove(ContainerReference, boolean) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
-
Remove a specific container.
- remove(ImageReference, boolean) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
-
Remove a specific image.
- ResolvedDockerHost - Class in org.springframework.boot.buildpack.platform.docker.configuration
-
Resolves a
DockerHost
from the environment, configuration, or using defaults. - ROOT - Static variable in interface org.springframework.boot.buildpack.platform.io.Owner
-
Owner for root ownership.
- runningPhase(BuildRequest, String) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- runningPhase(BuildRequest, String) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that a specific phase is running.
S
- SharedObjectMapper - Class in org.springframework.boot.buildpack.platform.json
-
Provides access to a shared pre-configured
ObjectMapper
. - shutdownInput() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- shutdownOutput() - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- size() - Method in class org.springframework.boot.buildpack.platform.docker.type.Layer
- size() - Method in interface org.springframework.boot.buildpack.platform.io.Content
-
The size of the content in bytes.
- size() - Method in class org.springframework.boot.buildpack.platform.io.InspectedContent
- skippingPhase(String, String) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- skippingPhase(String, String) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that a specific phase is being skipped.
- SOCK_STREAM - Static variable in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- SslContextFactory - Class in org.springframework.boot.buildpack.platform.docker.ssl
-
Builds an
SSLContext
for use with an HTTP connection. - SslContextFactory() - Constructor for class org.springframework.boot.buildpack.platform.docker.ssl.SslContextFactory
- start(BuildRequest) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- start(BuildRequest) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that a build is starting.
- start(ContainerReference) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
-
Start a specific container.
- STD_ERR - Enum constant in enum class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent.StreamType
-
Output to
stderr
. - STD_IN - Enum constant in enum class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent.StreamType
-
Input from
stdin
. - STD_OUT - Enum constant in enum class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent.StreamType
-
Output to
stdout
. - stream() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors
-
Returns a sequential
Stream
of the errors. - SYSTEM - Static variable in interface org.springframework.boot.buildpack.platform.system.Environment
-
Standard
Environment
implementation backed bySystem.getenv(String)
.
T
- tag(ImageReference, ImageReference) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi
- taggedImage(ImageReference) - Method in class org.springframework.boot.buildpack.platform.build.AbstractBuildLog
- taggedImage(ImageReference) - Method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Log that a tag has been created.
- TarArchive - Interface in org.springframework.boot.buildpack.platform.io
-
A TAR archive that can be written to an output stream.
- to(PrintStream) - Static method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Factory method that returns a
BuildLog
the outputs to a givenPrintStream
. - toLegacyString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
- toLegacyString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
- toString() - Method in class org.springframework.boot.buildpack.platform.build.BuildpackReference
- toString() - Method in class org.springframework.boot.buildpack.platform.build.Creator
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.PushImageUpdateEvent.ErrorDetail
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors.Error
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Errors
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.transport.Message
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.Binding
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerReference
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageName
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.LayerId
- toString() - Method in class org.springframework.boot.buildpack.platform.docker.type.VolumeName
- toSystemOut() - Static method in interface org.springframework.boot.buildpack.platform.build.BuildLog
-
Factory method that returns a
BuildLog
the outputs toSystem.out
. - TotalProgressBar - Class in org.springframework.boot.buildpack.platform.docker
-
Utility to render a simple progress bar based on consumed
TotalProgressEvent
objects. - TotalProgressBar(String) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressBar
-
Create a new
TotalProgressBar
instance. - TotalProgressBar(String, char, boolean, PrintStream) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressBar
-
Create a new
TotalProgressBar
instance. - TotalProgressBar(String, PrintStream) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressBar
-
Create a new
TotalProgressBar
instance. - TotalProgressEvent - Class in org.springframework.boot.buildpack.platform.docker
-
Event published by the
TotalProgressPullListener
showing the total progress of an operation. - TotalProgressEvent(int) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressEvent
-
Create a new
TotalProgressEvent
with a specific percent value. - TotalProgressListener<E extends ImageProgressUpdateEvent> - Class in org.springframework.boot.buildpack.platform.docker
-
UpdateListener
that calculates the total progress of the entire image operation and publishesTotalProgressEvent
. - TotalProgressListener(Consumer<TotalProgressEvent>, String[]) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressListener
-
Create a new
TotalProgressListener
that sendsevents
to the given consumer. - TotalProgressPullListener - Class in org.springframework.boot.buildpack.platform.docker
-
UpdateListener
that calculates the total progress of the entire pull operation and publishesTotalProgressEvent
. - TotalProgressPullListener(String) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressPullListener
-
Create a new
TotalProgressPullListener
that prints a progress bar toSystem.out
. - TotalProgressPullListener(Consumer<TotalProgressEvent>) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressPullListener
-
Create a new
TotalProgressPullListener
that sendsevents
to the given consumer. - TotalProgressPushListener - Class in org.springframework.boot.buildpack.platform.docker
-
UpdateListener
that calculates the total progress of the entire push operation and publishesTotalProgressEvent
. - TotalProgressPushListener(String) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressPushListener
-
Create a new
TotalProgressPushListener
that prints a progress bar toSystem.out
. - TotalProgressPushListener(Consumer<TotalProgressEvent>) - Constructor for class org.springframework.boot.buildpack.platform.docker.TotalProgressPushListener
-
Create a new
TotalProgressPushListener
that sendsevents
to the given consumer.
U
- umaskForPath(Path) - Static method in class org.springframework.boot.buildpack.platform.io.FilePermissions
-
Return the integer representation of the file permissions for a path, where the integer value conforms to the umask octal notation.
- update(byte[], int, int) - Method in interface org.springframework.boot.buildpack.platform.io.InspectedContent.Inspector
-
Update inspected information based on the provided bytes.
- UpdateEvent - Class in org.springframework.boot.buildpack.platform.docker
-
Base class for update events published by Docker.
- UpdateEvent() - Constructor for class org.springframework.boot.buildpack.platform.docker.UpdateEvent
- UpdateListener<E extends UpdateEvent> - Interface in org.springframework.boot.buildpack.platform.docker
-
Listener for update events published from the
DockerApi
.
V
- valueAt(Object, String, Class<T>) - Static method in class org.springframework.boot.buildpack.platform.json.MappedObject
- valueAt(String, Class<T>) - Method in class org.springframework.boot.buildpack.platform.json.MappedObject
-
Get the value at the given JSON path expression as a specific type.
- valueOf(String) - Static method in enum class org.springframework.boot.buildpack.platform.build.Cache.Format
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.buildpack.platform.build.PullPolicy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent.StreamType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.boot.buildpack.platform.build.Cache.Format
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.buildpack.platform.build.PullPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.buildpack.platform.docker.LogUpdateEvent.StreamType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- volume() - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi
- volume(String) - Static method in class org.springframework.boot.buildpack.platform.build.Cache
-
Create a new
Cache
that uses a volume with the provided name. - VOLUME - Enum constant in enum class org.springframework.boot.buildpack.platform.build.Cache.Format
-
A cache stored as a volume in the Docker daemon.
- VolumeName - Class in org.springframework.boot.buildpack.platform.docker.type
-
A Docker volume name.
W
- wait(ContainerReference) - Method in class org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
-
Wait for a container to stop and retrieve the status.
- withApplicationDirectory(String) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated application directory. - withArgs(String...) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with additional args.
- withBindHostToBuilder(boolean) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withBinding(Binding) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with an additional binding.
- withBindings(List<Binding>) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with updated bindings. - withBindings(Binding...) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with updated bindings. - withBuildCache(Cache) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated build cache. - withBuilder(ImageReference) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated builder. - withBuilderRegistryTokenAuthentication(String) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withBuilderRegistryUserAuthentication(String, String, String, String) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withBuildpacks(List<BuildpackReference>) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated buildpacks setting. - withBuildpacks(BuildpackReference...) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated buildpacks setting. - withCleanCache(boolean) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated clean cache setting. - withCommand(String, String...) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with a specific command.
- withCreateDate(Instant) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive.Update
-
Set the create date for the image archive.
- withCreatedDate(String) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated created date. - withCreator(Creator) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated creator. - withDigest(String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageReference
-
Create a new
ImageReference
with an updated digest. - withEmptyPublishRegistryAuthentication() - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withEnv(String, String) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an additional env variable. - withEnv(String, String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with an additional environment variable.
- withEnv(Map<String, String>) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with additional env variables. - withHost(String, boolean, String) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withLabel(String, String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with an additional label.
- withLabel(String, String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageConfig.Update
-
Update the image config with an additional label.
- withLaunchCache(Cache) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated launch cache. - withNetwork(String) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated network setting. - withNetworkMode(String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with the network that the build container will connect to.
- withNewLayer(Layer) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive.Update
-
Add a new layer to the image archive.
- withPublish(boolean) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated publish setting. - withPublishRegistryTokenAuthentication(String) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withPublishRegistryUserAuthentication(String, String, String, String) - Method in class org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration
- withPullPolicy(PullPolicy) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with the updated image pull policy. - withRunImage(ImageReference) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated run image. - withSecurityOption(String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with a security option.
- withTag(ImageReference) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive.Update
-
Set the tag for the image archive.
- withTags(List<ImageReference>) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with updated tags. - withTags(ImageReference...) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with updated tags. - withUpdatedConfig(Consumer<ImageConfig.Update>) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive.Update
-
Apply updates to the
ImageConfig
. - withUser(String) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig.Update
-
Update the container config with a specific user.
- withVerboseLogging(boolean) - Method in class org.springframework.boot.buildpack.platform.build.BuildRequest
-
Return a new
BuildRequest
with an updated verbose logging setting. - withVersion(String) - Static method in class org.springframework.boot.buildpack.platform.build.Creator
-
Create a new
Creator
using the provided version. - write(ByteBuffer) - Method in class org.springframework.boot.buildpack.platform.socket.DomainSocket
- writeTo(OutputStream) - Method in class org.springframework.boot.buildpack.platform.docker.type.ContainerConfig
-
Write this container configuration to the specified
OutputStream
. - writeTo(OutputStream) - Method in class org.springframework.boot.buildpack.platform.docker.type.ImageArchive
- writeTo(OutputStream) - Method in class org.springframework.boot.buildpack.platform.docker.type.Layer
- writeTo(OutputStream) - Method in interface org.springframework.boot.buildpack.platform.io.Content
-
Write the content to the given output stream.
- writeTo(OutputStream) - Method in class org.springframework.boot.buildpack.platform.io.InspectedContent
- writeTo(OutputStream) - Method in interface org.springframework.boot.buildpack.platform.io.TarArchive
-
Write the TAR archive to the given output stream.
- writeTo(OutputStream) - Method in class org.springframework.boot.buildpack.platform.io.ZipFileTarArchive
Z
- ZipFileTarArchive - Class in org.springframework.boot.buildpack.platform.io
-
Adapter class to convert a ZIP file to a
TarArchive
. - ZipFileTarArchive(File, Owner) - Constructor for class org.springframework.boot.buildpack.platform.io.ZipFileTarArchive
-
Creates an archive from the contents of the given
zip
.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form