Package io.github.gmazzo.docker.compose

Interface DockerComposeSettings.WaitForTCPPorts

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract Property<Boolean> getEnabled() Instructs the service to wait for TCP ports, enabled by default.
      abstract SetProperty<String> getInclude() Ports to wait to be open and accepting connections.
      abstract SetProperty<String> getExclude() Ports to exclude from waiting to be open and accepting connections.
      abstract Property<Integer> getTimeout() The maximum time to wait for the ports to become available (in milliseconds).

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getEnabled

         abstract Property<Boolean> getEnabled()

        Instructs the service to wait for TCP ports, enabled by default.

      • getInclude

         abstract SetProperty<String> getInclude()

        Ports to wait to be open and accepting connections. If missing, waits for all ports

        The format should <containerName>:tcp<portNumber>. i.e. main-app-1:tcp80

      • getExclude

         abstract SetProperty<String> getExclude()

        Ports to exclude from waiting to be open and accepting connections. If missing, does not exclude any

        The format should <containerName>:tcp<portNumber>. i.e. main-app-1:tcp80

      • getTimeout

         abstract Property<Integer> getTimeout()

        The maximum time to wait for the ports to become available (in milliseconds). Defaults to 1 minute