Interface RunningService

public interface RunningService
Provides details of a running Docker Compose service.
Since:
3.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable DockerComposeFile
    composeFile()
    Return the Docker Compose file for the service.
    Map<String, @Nullable String>
    env()
    Return the environment defined for the service.
    String
    host()
    Return the host that can be used to connect to the service.
    ImageReference
    image()
    Return the image being used by the service.
    Map<String,String>
    labels()
    Return the labels attached to the service.
    String
    name()
    Return the name of the service.
    ConnectionPorts
    ports()
    Return the ports that can be used to connect to the service.

  • 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, @Nullable 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 @Nullable DockerComposeFile composeFile()
      Return the Docker Compose file for the service.
      Returns:
      the Docker Compose file
      Since:
      3.5.0