Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ALWAYS - Enum constant in enum class io.github.pgatzka.docker.dsl.PullPolicy
-
Always pull the image, even if a local copy already exists.
- apply(Project) - Method in class io.github.pgatzka.docker.DockerPlugin
-
Apply the plugin to
project: install thedockerextension, register the sharedDockerService, and register tasks for each declared container, volume, and network.
B
- bind(String, String) - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Register a read-write host bind mount.
- bind(String, String, boolean) - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Register a host bind mount.
- BindMount - Record Class in io.github.pgatzka.docker.dsl.mount
-
Immutable description of a host-path bind mount attached to a container.
- BindMount(String, String, boolean) - Constructor for record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Creates an instance of a
BindMountrecord class. - bindMounts() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
bindMountsrecord component. - binds() - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Snapshot the registered bind mounts.
C
- close() - Method in class io.github.pgatzka.docker.service.DockerService
-
Close the underlying
DockerClient, if any, and reset internal state so the service can be reused. - command() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
commandrecord component. - containerName() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
containerNamerecord component. - containerPath() - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Returns the value of the
containerPathrecord component. - containerPath() - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Returns the value of the
containerPathrecord component. - ContainerSpec - Class in io.github.pgatzka.docker.dsl.spec
-
Spec describing a single Docker container the plugin will manage.
- ContainerSpec(String) - Constructor for class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Invoked by Gradle's
ObjectFactorywhen a container is registered. - createNetworkTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the create-network task name for a network spec.
- CreateNetworkTask - Class in io.github.pgatzka.docker.task.network
-
Creates a Docker network according to its
NetworkSpec. - CreateNetworkTask() - Constructor for class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- createVolumeTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the create-volume task name for a volume spec.
- CreateVolumeTask - Class in io.github.pgatzka.docker.task.volume
-
Creates a Docker named volume according to its
VolumeSpec. - CreateVolumeTask() - Constructor for class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
D
- DockerExtension - Interface in io.github.pgatzka.docker.dsl
-
Root DSL surface registered as the
dockerextension on a Gradle project. - DockerExtensionImpl - Class in io.github.pgatzka.docker
-
Concrete implementation of
DockerExtensionthat Gradle decorates and instantiates. - DockerExtensionImpl(NamedDomainObjectContainer<ContainerSpec>, NamedDomainObjectContainer<VolumeSpec>, NamedDomainObjectContainer<NetworkSpec>) - Constructor for class io.github.pgatzka.docker.DockerExtensionImpl
-
Invoked by Gradle's
ObjectFactoryduring extension creation. - DockerPlugin - Class in io.github.pgatzka.docker
-
Entry point for the
io.github.pgatzka.dockerGradle plugin. - DockerPlugin() - Constructor for class io.github.pgatzka.docker.DockerPlugin
-
Public no-arg constructor invoked by Gradle when applying the plugin.
- DockerService - Class in io.github.pgatzka.docker.service
-
Gradle
BuildServicethat owns a singleDockerClientfor the whole build. - DockerService() - Constructor for class io.github.pgatzka.docker.service.DockerService
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- DockerTask - Class in io.github.pgatzka.docker.task
-
Base class for all Docker-related Gradle tasks contributed by this plugin.
- DockerTask() - Constructor for class io.github.pgatzka.docker.task.DockerTask
-
Creates a new Docker task and places it in the
"docker"group so it shows up grouped under that heading in./gradlew tasks.
E
- env() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
envrecord component. - equals(Object) - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.dsl.waitable.Healthcheck
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.dsl.waitable.LogLine
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.dsl.waitable.None
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.dsl.waitable.TcpPort
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Indicates whether some other object is "equal to" this one.
- execute() - Method in class io.github.pgatzka.docker.task.container.RemoveContainerTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.container.StopContainerTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.network.RemoveNetworkTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Gradle entry point for this task.
- execute() - Method in class io.github.pgatzka.docker.task.volume.RemoveVolumeTask
-
Gradle entry point for this task.
G
- getAttachable() - Method in class io.github.pgatzka.docker.dsl.spec.NetworkSpec
-
Whether non-service containers may attach to the network (
--attachable). - getAttachable() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Mirrors
NetworkSpec.attachable: whentrue, standalone containers may attach to this network. - getBindMounts() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.bindMounts: host-path bind mounts to attach. - getClient() - Method in class io.github.pgatzka.docker.service.DockerService
-
Lazily construct the shared
DockerClienton first call and verify the daemon is reachable; subsequent calls return the cached client without re-pinging. - getCommand() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Override the image's default
CMD. - getCommand() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.command: override for the image's CMD, or empty to keep the image default. - getContainerName() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Docker container name to use at
docker runtime. - getContainerName() - Method in class io.github.pgatzka.docker.task.container.RemoveContainerTask
-
Mirrors
ContainerSpec.name: the container name to remove. - getContainerName() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.name: the container name registered on the daemon. - getContainerName() - Method in class io.github.pgatzka.docker.task.container.StopContainerTask
-
Mirrors
ContainerSpec.name: the container name on the daemon. - getContainers() - Method in class io.github.pgatzka.docker.DockerExtensionImpl
- getContainers() - Method in interface io.github.pgatzka.docker.dsl.DockerExtension
-
Containers declared via
docker { containers { register("...") { ... } } }. - getDockerService() - Method in class io.github.pgatzka.docker.task.DockerTask
-
The shared
DockerServicebuild service that owns theDockerClientconnection. - getDriver() - Method in class io.github.pgatzka.docker.dsl.spec.NetworkSpec
-
Network driver passed to
docker network create --driver. - getDriver() - Method in class io.github.pgatzka.docker.dsl.spec.VolumeSpec
-
Volume driver passed to
docker volume create --driver. - getDriver() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Mirrors
NetworkSpec.driver: the network driver (e.g. - getDriver() - Method in class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Mirrors
VolumeSpec.driver: the volume driver (e.g. - getDriverOpts() - Method in class io.github.pgatzka.docker.dsl.spec.VolumeSpec
-
Driver-specific options forwarded as
--opt KEY=VALUEpairs. - getDriverOpts() - Method in class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Mirrors
VolumeSpec.driverOpts: driver-specific options forwarded to the daemon. - getEnvironment() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Environment variables passed to the container as
-e KEY=VALUEpairs. - getEnvironment() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Container environment values, mirroring
ContainerSpec.env. - getImage() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Image reference, e.g.
- getImage() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.image: the image reference (e.g. - getInternal() - Method in class io.github.pgatzka.docker.dsl.spec.NetworkSpec
-
Whether the network is
--internal(no outbound connectivity). - getInternal() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Mirrors
NetworkSpec.internal: whentrue, the network is isolated from external networks. - getLabels() - Method in class io.github.pgatzka.docker.dsl.spec.NetworkSpec
-
Labels applied to the network as
--label KEY=VALUEpairs. - getLabels() - Method in class io.github.pgatzka.docker.dsl.spec.VolumeSpec
-
Labels applied to the volume as
--label KEY=VALUEpairs. - getLabels() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Mirrors
NetworkSpec.labels: labels applied to the network on the daemon. - getLabels() - Method in class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Mirrors
VolumeSpec.labels: labels applied to the volume on the daemon. - getMounts() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Mutable builder collecting volume and bind mounts declared via
ContainerSpec.mounts(Action). - getName() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
- getName() - Method in class io.github.pgatzka.docker.dsl.spec.NetworkSpec
- getName() - Method in class io.github.pgatzka.docker.dsl.spec.VolumeSpec
- getNetworkName() - Method in class io.github.pgatzka.docker.task.network.CreateNetworkTask
-
Mirrors
NetworkSpec.name: the network name registered on the daemon. - getNetworkName() - Method in class io.github.pgatzka.docker.task.network.RemoveNetworkTask
-
Mirrors
NetworkSpec.name: the network name to remove. - getNetworks() - Method in class io.github.pgatzka.docker.DockerExtensionImpl
- getNetworks() - Method in interface io.github.pgatzka.docker.dsl.DockerExtension
-
Networks declared via
docker { networks { register("...") { ... } } }. - getNetworks() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Names of networks (declared in
docker.networks) this container should attach to. - getNetworks() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.networks: declared networks; the first becomes the container's primary network and any remaining ones are attached after creation. - getPorts() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Published ports: keys are host ports, values are container ports.
- getPorts() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.ports: host port to container port mappings. - getPullPolicy() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
When the plugin should pull the image.
- getPullPolicy() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.pullPolicy: when (if ever) to pull the image before start. - getStopTimeout() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Grace period passed to
docker stopbeforeSIGKILL. - getStopTimeout() - Method in class io.github.pgatzka.docker.task.container.StopContainerTask
-
Mirrors
ContainerSpec.stopTimeout: the grace period before the daemon escalates to SIGKILL. - getVolumeMounts() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.volumeMounts: named-volume mounts to attach. - getVolumeName() - Method in class io.github.pgatzka.docker.task.volume.CreateVolumeTask
-
Mirrors
VolumeSpec.name: the volume name registered on the daemon. - getVolumeName() - Method in class io.github.pgatzka.docker.task.volume.RemoveVolumeTask
-
Mirrors
VolumeSpec.name: the volume name to remove. - getVolumes() - Method in class io.github.pgatzka.docker.DockerExtensionImpl
- getVolumes() - Method in interface io.github.pgatzka.docker.dsl.DockerExtension
-
Volumes declared via
docker { volumes { register("...") { ... } } }. - getWait() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Readiness strategy used by the generated
start<ContainerName>task. - getWaitFor() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.waitFor: the readiness strategy applied after start. - getWaitTimeout() - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Maximum time the start task waits for
ContainerSpec.getWait()to succeed before failing. - getWaitTimeout() - Method in class io.github.pgatzka.docker.task.container.StartContainerTask
-
Mirrors
ContainerSpec.waitTimeout: maximum time to wait for readiness.
H
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.waitable.Healthcheck
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.waitable.LogLine
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.waitable.None
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.dsl.waitable.TcpPort
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns a hash code value for this object.
- healthcheck() - Static method in interface io.github.pgatzka.docker.dsl.waitable.Waitable
-
Wait until the container's Docker
HEALTHCHECKreportshealthy. - healthcheck(DockerClient, String, Duration, Duration) - Static method in class io.github.pgatzka.docker.internal.Readiness
-
Poll the daemon's healthcheck status for
containerIduntil it reportshealthyortimeoutelapses. - Healthcheck - Record Class in io.github.pgatzka.docker.dsl.waitable
-
Readiness strategy that waits for the container's Docker
HEALTHCHECKto reporthealthy. - Healthcheck() - Constructor for record class io.github.pgatzka.docker.dsl.waitable.Healthcheck
-
Creates an instance of a
Healthcheckrecord class. - hostPath() - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Returns the value of the
hostPathrecord component.
I
- IF_NOT_PRESENT - Enum constant in enum class io.github.pgatzka.docker.dsl.PullPolicy
-
Pull only when no local image with the requested reference is present.
- image() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
imagerecord component. - io.github.pgatzka.docker - package io.github.pgatzka.docker
- io.github.pgatzka.docker.dsl - package io.github.pgatzka.docker.dsl
- io.github.pgatzka.docker.dsl.mount - package io.github.pgatzka.docker.dsl.mount
- io.github.pgatzka.docker.dsl.spec - package io.github.pgatzka.docker.dsl.spec
- io.github.pgatzka.docker.dsl.waitable - package io.github.pgatzka.docker.dsl.waitable
- io.github.pgatzka.docker.internal - package io.github.pgatzka.docker.internal
- io.github.pgatzka.docker.service - package io.github.pgatzka.docker.service
- io.github.pgatzka.docker.task - package io.github.pgatzka.docker.task
- io.github.pgatzka.docker.task.container - package io.github.pgatzka.docker.task.container
- io.github.pgatzka.docker.task.network - package io.github.pgatzka.docker.task.network
- io.github.pgatzka.docker.task.volume - package io.github.pgatzka.docker.task.volume
L
- logLine(DockerClient, String, String, Duration) - Static method in class io.github.pgatzka.docker.internal.Readiness
-
Stream the container's combined stdout/stderr logs until a line matches
regexortimeoutelapses. - logLine(String) - Static method in interface io.github.pgatzka.docker.dsl.waitable.Waitable
-
Wait until a line matching
regexappears in the container's stdout/stderr stream. - LogLine - Record Class in io.github.pgatzka.docker.dsl.waitable
-
Readiness strategy that waits until a log line matching
regexis observed on the container's stdout or stderr. - LogLine(String) - Constructor for record class io.github.pgatzka.docker.dsl.waitable.LogLine
-
Creates an instance of a
LogLinerecord class. - logLineMatch(String, String) - Static method in class io.github.pgatzka.docker.internal.Readiness
-
Pure-logic helper used by unit tests: returns whether any line in
textmatchesregex.
M
- mounts(Action<? super Mounts>) - Method in class io.github.pgatzka.docker.dsl.spec.ContainerSpec
-
Configure volume and bind mounts for this container.
- Mounts - Class in io.github.pgatzka.docker.dsl
-
Mutable builder for a container's volume and bind mounts.
- Mounts() - Constructor for class io.github.pgatzka.docker.dsl.Mounts
-
Default constructor for use by
ContainerSpec; not intended for direct use.
N
- Names - Class in io.github.pgatzka.docker.internal
-
Pure utility that derives Gradle task names from user-declared spec names.
- networks() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
networksrecord component. - NetworkSpec - Class in io.github.pgatzka.docker.dsl.spec
-
Spec describing a Docker network the plugin will create and manage.
- NetworkSpec(String) - Constructor for class io.github.pgatzka.docker.dsl.spec.NetworkSpec
-
Invoked by Gradle's
ObjectFactorywhen a network is registered. - NEVER - Enum constant in enum class io.github.pgatzka.docker.dsl.PullPolicy
-
Never pull; fail if the image is not already available locally.
- none() - Static method in interface io.github.pgatzka.docker.dsl.waitable.Waitable
-
No readiness check; the start task returns as soon as
docker runreturns. - None - Record Class in io.github.pgatzka.docker.dsl.waitable
-
Readiness strategy that performs no check; the start task completes as soon as
docker runreturns. - None() - Constructor for record class io.github.pgatzka.docker.dsl.waitable.None
-
Creates an instance of a
Nonerecord class. - NotReadyException - Exception Class in io.github.pgatzka.docker.internal
-
Thrown by
Readinesswhen a container does not reach the requested ready state within the configured timeout, or disappears mid-wait. - NotReadyException(String) - Constructor for exception class io.github.pgatzka.docker.internal.NotReadyException
-
Construct a new exception describing why readiness was not reached.
P
- port() - Method in record class io.github.pgatzka.docker.dsl.waitable.TcpPort
-
Returns the value of the
portrecord component. - ports() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
portsrecord component. - pullPolicy() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
pullPolicyrecord component. - PullPolicy - Enum Class in io.github.pgatzka.docker.dsl
-
Controls when the plugin pulls a container's image from a registry before
docker run.
R
- Readiness - Class in io.github.pgatzka.docker.internal
-
Container readiness probes used by start tasks.
- readOnly() - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Returns the value of the
readOnlyrecord component. - readOnly() - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Returns the value of the
readOnlyrecord component. - referencedVolumeNames() - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Names of the volumes referenced by registered volume mounts, in declaration order.
- regex() - Method in record class io.github.pgatzka.docker.dsl.waitable.LogLine
-
Returns the value of the
regexrecord component. - removeContainerTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the remove-container task name for a container spec.
- RemoveContainerTask - Class in io.github.pgatzka.docker.task.container
-
Force-removes a Docker container by name.
- RemoveContainerTask() - Constructor for class io.github.pgatzka.docker.task.container.RemoveContainerTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- removeNetworkTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the remove-network task name for a network spec.
- RemoveNetworkTask - Class in io.github.pgatzka.docker.task.network
-
Removes a Docker network by name.
- RemoveNetworkTask() - Constructor for class io.github.pgatzka.docker.task.network.RemoveNetworkTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- removeVolumeTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the remove-volume task name for a volume spec.
- RemoveVolumeTask - Class in io.github.pgatzka.docker.task.volume
-
Removes a Docker named volume by name.
- RemoveVolumeTask() - Constructor for class io.github.pgatzka.docker.task.volume.RemoveVolumeTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
S
- StartContainerTask - Class in io.github.pgatzka.docker.task.container
-
Starts a Docker container according to its
ContainerSpec. - StartContainerTask() - Constructor for class io.github.pgatzka.docker.task.container.StartContainerTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- StartContainerTaskParams - Record Class in io.github.pgatzka.docker.task.container
-
Snapshot of the inputs consumed by
StartContainerTask's package-privaterunhelper. - StartContainerTaskParams(String, String, Map<String, String>, Map<Integer, Integer>, List<String>, List<String>, List<VolumeMount>, List<BindMount>, Waitable, Duration, PullPolicy) - Constructor for record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Creates an instance of a
StartContainerTaskParamsrecord class. - startTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the start-container task name for a container spec.
- StopContainerTask - Class in io.github.pgatzka.docker.task.container
-
Stops a running Docker container, waiting up to the configured timeout for graceful shutdown before the daemon escalates to SIGKILL.
- StopContainerTask() - Constructor for class io.github.pgatzka.docker.task.container.StopContainerTask
-
Invoked by Gradle's bytecode-decorated subclass; not for direct use.
- stopTask(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Build the stop-container task name for a container spec.
T
- tcpPort(int) - Static method in interface io.github.pgatzka.docker.dsl.waitable.Waitable
-
Wait until the given TCP port inside the container accepts a connection.
- tcpPort(String, int, Duration, Duration) - Static method in class io.github.pgatzka.docker.internal.Readiness
-
Repeatedly attempt a TCP connection to
host:portuntil one succeeds ortimeoutelapses. - TcpPort - Record Class in io.github.pgatzka.docker.dsl.waitable
-
Readiness strategy that waits until the given TCP port (inside the container) accepts a connection.
- TcpPort(int) - Constructor for record class io.github.pgatzka.docker.dsl.waitable.TcpPort
-
Creates an instance of a
TcpPortrecord class. - toCamel(String) - Static method in class io.github.pgatzka.docker.internal.Names
-
Convert a spec name to its camelCase form, treating
_,-, and.as word boundaries. - toString() - Method in record class io.github.pgatzka.docker.dsl.mount.BindMount
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.dsl.waitable.Healthcheck
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.dsl.waitable.LogLine
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.dsl.waitable.None
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.dsl.waitable.TcpPort
-
Returns a string representation of this record class.
- toString() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns a string representation of this record class.
V
- validate(DockerExtension) - Static method in class io.github.pgatzka.docker.internal.Validation
-
Validate the configured Docker extension after evaluation.
- Validation - Class in io.github.pgatzka.docker.internal
-
Cross-reference and shape validation for the
docker {}extension. - valueOf(String) - Static method in enum class io.github.pgatzka.docker.dsl.PullPolicy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.pgatzka.docker.dsl.PullPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- volume(String, String) - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Register a read-write named-volume mount.
- volume(String, String, boolean) - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Register a named-volume mount.
- VolumeMount - Record Class in io.github.pgatzka.docker.dsl.mount
-
Immutable description of a named-volume mount attached to a container.
- VolumeMount(String, String, boolean) - Constructor for record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Creates an instance of a
VolumeMountrecord class. - volumeMounts() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
volumeMountsrecord component. - volumeName() - Method in record class io.github.pgatzka.docker.dsl.mount.VolumeMount
-
Returns the value of the
volumeNamerecord component. - volumes() - Method in class io.github.pgatzka.docker.dsl.Mounts
-
Snapshot the registered volume mounts.
- VolumeSpec - Class in io.github.pgatzka.docker.dsl.spec
-
Spec describing a Docker named volume the plugin will create and manage.
- VolumeSpec(String) - Constructor for class io.github.pgatzka.docker.dsl.spec.VolumeSpec
-
Invoked by Gradle's
ObjectFactorywhen a volume is registered.
W
- waitable() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
waitablerecord component. - Waitable - Interface in io.github.pgatzka.docker.dsl.waitable
-
Strategy that determines when
start<ContainerName>considers a container ready. - waitTimeout() - Method in record class io.github.pgatzka.docker.task.container.StartContainerTaskParams
-
Returns the value of the
waitTimeoutrecord component.
All Classes and Interfaces|All Packages|Serialized Form