Package org.springframework.boot.docker.compose.core

Interface RunningService

public interface RunningService
Provides details of a running Docker Compose service.
Since:
3.1.0
Author:
Moritz Halbritter, Andy Wilkinson, Phillip Webb

  • Method Details

    • name

      String name()
      Return the name of the service.
      Returns:
      the service name

    • image

      ImageReference image()
      Return the image being used by the service.
      Returns:
      the service image

    • host

      String host()
      Return the host that can be used to connect to the service.
      Returns:
      the service host

    • ports

      ConnectionPorts ports()
      Return the ports that can be used to connect to the service.
      Returns:
      the service ports

    • env

      Map<String,String> env()
      Return the environment defined for the service.
      Returns:
      the service env

    • labels

      Map<String,String> labels()
      Return the labels attached to the service.
      Returns:
      the service labels

    • composeFile

      default DockerComposeFile composeFile()
      Return the Docker Compose file for the service.
      Returns:
      the Docker Compose file
      Since:
      3.5.0