Index (spring-boot-docker-compose 3.3.1 API)

A B C D E F G H I J L N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

ALWAYS - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Wait: Always perform readiness checks.
appendParameters(StringBuilder, String) - Method in class org.springframework.boot.docker.compose.service.connection.jdbc.JdbcUrlBuilder: Appends to the given url the given parameters.

B

build(RunningService) - Method in class org.springframework.boot.docker.compose.service.connection.jdbc.JdbcUrlBuilder: Build a JDBC URL for the given RunningService.
build(RunningService, String) - Method in class org.springframework.boot.docker.compose.service.connection.jdbc.JdbcUrlBuilder: Build a JDBC URL for the given RunningService and database.
build(RunningService, String, String, String) - Method in class org.springframework.boot.docker.compose.service.connection.r2dbc.ConnectionFactoryOptionsBuilder

C

composeFile() - Method in record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Returns the value of the composeFile record component.
ConnectionFactoryOptionsBuilder - Class in org.springframework.boot.docker.compose.service.connection.r2dbc: Utility used to build an R2DBC ConnectionFactoryOptions for a RunningService.
ConnectionFactoryOptionsBuilder(String, int) - Constructor for class org.springframework.boot.docker.compose.service.connection.r2dbc.ConnectionFactoryOptionsBuilder: Create a new JdbcUrlBuilder instance.
ConnectionPorts - Interface in org.springframework.boot.docker.compose.core: Provides access to the ports that can be used to connect to a RunningService.

D

DockerCompose - Interface in org.springframework.boot.docker.compose.core: Provides a high-level API to work with Docker compose.
DockerComposeConnectionDetails(RunningService) - Constructor for class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails: Create a new DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails instance.
DockerComposeConnectionDetailsFactory<D extends org.springframework.boot.autoconfigure.service.connection.ConnectionDetails> - Class in org.springframework.boot.docker.compose.service.connection: Base class for ConnectionDetailsFactory implementations that provide ConnectionDetails from a DockerComposeConnectionSource.
DockerComposeConnectionDetailsFactory(String[], String...) - Constructor for class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory: Create a new DockerComposeConnectionDetailsFactory instance.
DockerComposeConnectionDetailsFactory(String, String...) - Constructor for class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory: Create a new DockerComposeConnectionDetailsFactory instance.
DockerComposeConnectionDetailsFactory(Predicate<DockerComposeConnectionSource>, String...) - Constructor for class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory: Create a new DockerComposeConnectionDetailsFactory instance.
DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails - Class in org.springframework.boot.docker.compose.service.connection: Convenient base class for ConnectionDetails results that are backed by a RunningService.
DockerComposeConnectionSource - Class in org.springframework.boot.docker.compose.service.connection: Passed to DockerComposeConnectionDetailsFactory to provide details of the running docker compose service.
DockerComposeFile - Class in org.springframework.boot.docker.compose.core: A reference to a docker compose file (usually named compose.yaml).
DockerComposeOrigin - Record Class in org.springframework.boot.docker.compose.core: An origin which points to a service defined in docker compose.
DockerComposeOrigin(DockerComposeFile, String) - Constructor for record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Creates an instance of a DockerComposeOrigin record class.
DockerComposeProperties - Class in org.springframework.boot.docker.compose.lifecycle: Configuration properties for Docker Compose.
DockerComposeProperties() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
DockerComposeProperties.Profiles - Class in org.springframework.boot.docker.compose.lifecycle: Profiles properties.
DockerComposeProperties.Readiness - Class in org.springframework.boot.docker.compose.lifecycle: Readiness properties.
DockerComposeProperties.Readiness.Tcp - Class in org.springframework.boot.docker.compose.lifecycle: TCP properties.
DockerComposeProperties.Readiness.Wait - Enum Class in org.springframework.boot.docker.compose.lifecycle: Readiness wait strategies.
DockerComposeProperties.Skip - Class in org.springframework.boot.docker.compose.lifecycle: Skip options.
DockerComposeProperties.Start - Class in org.springframework.boot.docker.compose.lifecycle: Start properties.
DockerComposeProperties.Start.Skip - Enum Class in org.springframework.boot.docker.compose.lifecycle: Start command skip mode.
DockerComposeProperties.Stop - Class in org.springframework.boot.docker.compose.lifecycle: Stop properties.
DockerComposeServicesReadyEvent - Class in org.springframework.boot.docker.compose.lifecycle: ApplicationEvent published when Docker Compose RunningService instances are available.
DockerException - Exception in org.springframework.boot.docker.compose.core: Base class for docker exceptions.
DockerException(String) - Constructor for exception org.springframework.boot.docker.compose.core.DockerException
DockerException(String, Throwable) - Constructor for exception org.springframework.boot.docker.compose.core.DockerException
DockerNotRunningException - Exception in org.springframework.boot.docker.compose.core: DockerException thrown if the docker daemon is not running.
DockerOutputParseException - Exception in org.springframework.boot.docker.compose.core: DockerException thrown if the docker JSON cannot be parsed.
DockerProcessStartException - Exception in org.springframework.boot.docker.compose.core: DockerException thrown if the docker process cannot be started.
down(Duration) - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Run docker compose down to stop and remove any running services.
DOWN - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.StopCommand: Stop using docker compose down.

E

env() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the environment defined for the service.
equals(Object) - Method in class org.springframework.boot.docker.compose.core.DockerComposeFile
equals(Object) - Method in record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class org.springframework.boot.docker.compose.core.ImageReference

F

find(File) - Static method in class org.springframework.boot.docker.compose.core.DockerComposeFile: Find the docker compose file by searching in the given working directory.
FORCE_STOP - Static variable in interface org.springframework.boot.docker.compose.core.DockerCompose: Timeout duration used to request a forced stop.

G

get(int) - Method in interface org.springframework.boot.docker.compose.core.ConnectionPorts: Return the host port mapped to the given container port.
get(DockerComposeFile, String, Set<String>) - Static method in interface org.springframework.boot.docker.compose.core.DockerCompose: Factory method used to create a DockerCompose instance.
getActive() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Profiles
getAll() - Method in interface org.springframework.boot.docker.compose.core.ConnectionPorts: Return all host ports in use.
getAll(String) - Method in interface org.springframework.boot.docker.compose.core.ConnectionPorts: Return all host ports in use that match the given protocol.
getCommand() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
getCommand() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Stop
getConnectionDetails(DockerComposeConnectionSource) - Method in class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory
getConnectTimeout() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Tcp
getDigest() - Method in class org.springframework.boot.docker.compose.core.ImageReference: Return the digest from the reference or null.
getDockerComposeConnectionDetails(DockerComposeConnectionSource) - Method in class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory: Get the ConnectionDetails from the given RunningService source.
getDomain() - Method in class org.springframework.boot.docker.compose.core.ImageReference: Return the domain for this image name.
getErrorOutput() - Method in exception org.springframework.boot.docker.compose.core.DockerNotRunningException: Return the error output returned from docker.
getFile() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getHost() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getLifecycleManagement() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getLogLevel() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
getName() - Method in class org.springframework.boot.docker.compose.core.ImageReference: Return the name of this image.
getOrigin() - Method in class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory.DockerComposeConnectionDetails
getProfiles() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getReadiness() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getReadTimeout() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Tcp
getRunningService() - Method in class org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionSource: Return the running docker compose service.
getRunningServices() - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Return the running services for the active profile, or an empty list if no services are running.
getRunningServices() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeServicesReadyEvent: Return the relevant docker compose services that are running.
getSkip() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getSkip() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
getSource() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeServicesReadyEvent
getStart() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getStop() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
getTag() - Method in class org.springframework.boot.docker.compose.core.ImageReference: Return the tag from the reference or null.
getTcp() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness
getTimeout() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness
getTimeout() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Stop
getTimeout() - Method in exception org.springframework.boot.docker.compose.lifecycle.ReadinessTimeoutException: Return the timeout that was reached.
getWait() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness

H

hasDefinedServices() - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Return if services have been defined in the DockerComposeFile for the active profiles.
hashCode() - Method in class org.springframework.boot.docker.compose.core.DockerComposeFile
hashCode() - Method in record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Returns a hash code value for this object.
hashCode() - Method in class org.springframework.boot.docker.compose.core.ImageReference
host() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the host that can be used to connect to the service.

I

IF_RUNNING - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start.Skip: Skip start if there are already services running.
image() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the image being used by the service.
ImageReference - Class in org.springframework.boot.docker.compose.core: A reference to a Docker image of the form "imagename[:tag|@digest]".
isEnabled() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
isInTests() - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Skip

J

JdbcUrlBuilder - Class in org.springframework.boot.docker.compose.service.connection.jdbc: Utility used to build a JDBC URL for a RunningService.
JdbcUrlBuilder(String, int) - Constructor for class org.springframework.boot.docker.compose.service.connection.jdbc.JdbcUrlBuilder: Create a new JdbcUrlBuilder instance.

L

labels() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the labels attached to the service.
LifecycleManagement - Enum Class in org.springframework.boot.docker.compose.lifecycle: Docker Compose lifecycle management.

N

name() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the name of the service.
NEVER - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Wait: Never perform readiness checks.
NEVER - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start.Skip: Never skip start.
NONE - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.LifecycleManagement: Don't start or stop Docker Compose.

O

of(File) - Static method in class org.springframework.boot.docker.compose.core.DockerComposeFile: Create a new DockerComposeFile for the given File.
of(String) - Static method in class org.springframework.boot.docker.compose.core.ImageReference: Create a new ImageReference from the given value.
ONLY_IF_STARTED - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Wait: Only perform readiness checks if docker was started with lifecycle management.
org.springframework.boot.docker.compose.core - package org.springframework.boot.docker.compose.core: Core interfaces and classes for working with docker compose.
org.springframework.boot.docker.compose.lifecycle - package org.springframework.boot.docker.compose.lifecycle: Lifecycle management for Docker Compose with the context of a Spring application.
org.springframework.boot.docker.compose.service.connection - package org.springframework.boot.docker.compose.service.connection: Service connection support for Docker Compose.
org.springframework.boot.docker.compose.service.connection.jdbc - package org.springframework.boot.docker.compose.service.connection.jdbc: Utilities to help when creating JdbcConnectionDetails.
org.springframework.boot.docker.compose.service.connection.r2dbc - package org.springframework.boot.docker.compose.service.connection.r2dbc: Utilities to help when creating R2dbcConnectionDetails.

P

ports() - Method in interface org.springframework.boot.docker.compose.core.RunningService: Return the ports that can be used to connect to the service.
Profiles() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Profiles

R

Readiness() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness
ReadinessTimeoutException - Exception in org.springframework.boot.docker.compose.lifecycle: Exception thrown if readiness checking has timed out.
RunningService - Interface in org.springframework.boot.docker.compose.core: Provides details of a running docker compose service.

S

serviceName() - Method in record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Returns the value of the serviceName record component.
setActive(Set<String>) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Profiles
setCommand(StartCommand) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
setCommand(StopCommand) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Stop
setConnectTimeout(Duration) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Tcp
setEnabled(boolean) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
setFile(File) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
setHost(String) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
setInTests(boolean) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Skip
setLifecycleManagement(LifecycleManagement) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties
setLogLevel(LogLevel) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
setReadTimeout(Duration) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Tcp
setSkip(DockerComposeProperties.Start.Skip) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
setTimeout(Duration) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness
setTimeout(Duration) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Stop
setWait(DockerComposeProperties.Readiness.Wait) - Method in class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness
Skip() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Skip
start(LogLevel) - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Run docker compose start to start services.
Start() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start
START - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.StartCommand: Start using docker compose start.
START_AND_STOP - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.LifecycleManagement: Start Docker Compose if it's not running and stop it when the JVM exits.
START_ONLY - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.LifecycleManagement: Start Docker Compose if it's not running.
StartCommand - Enum Class in org.springframework.boot.docker.compose.lifecycle: Command used to start Docker Compose.
stop(Duration) - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Run docker compose stop to stop any running services.
Stop() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Stop
STOP - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.StopCommand: Stop using docker compose stop.
StopCommand - Enum Class in org.springframework.boot.docker.compose.lifecycle: Command used to stop Docker Compose.

T

Tcp() - Constructor for class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Tcp
toString() - Method in class org.springframework.boot.docker.compose.core.DockerComposeFile
toString() - Method in record class org.springframework.boot.docker.compose.core.DockerComposeOrigin: Returns a string representation of this record class.
toString() - Method in class org.springframework.boot.docker.compose.core.ImageReference

U

up(LogLevel) - Method in interface org.springframework.boot.docker.compose.core.DockerCompose: Run docker compose up to create and start services.
UP - Enum constant in enum class org.springframework.boot.docker.compose.lifecycle.StartCommand: Start using docker compose up.

V

valueOf(String) - Static method in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Wait: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Start.Skip: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.boot.docker.compose.lifecycle.LifecycleManagement: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.boot.docker.compose.lifecycle.StartCommand: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.springframework.boot.docker.compose.lifecycle.StopCommand: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.springframework.boot.docker.compose.lifecycle.DockerComposeProperties.Readiness.Wait: 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.docker.compose.lifecycle.DockerComposeProperties.Start.Skip: 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.docker.compose.lifecycle.LifecycleManagement: 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.docker.compose.lifecycle.StartCommand: 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.docker.compose.lifecycle.StopCommand: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I J L N O P R S T U V
All Classes and Interfaces|All Packages|Serialized Form