Package dev.galasa.docker
Interface IDockerContainerConfig
public interface IDockerContainerConfig
An interface for the annotation object that represents the configurations for a container.
-
Method Summary
Modifier and TypeMethodDescriptiongetEnvs()
Returns the list of specified Keys and Values for the envs desired to be setRetruns a list of exposed portsgetVolumeByTag
(String volumeTag) Get the volume by the tag it is known as.Lists all the provisioned/binded volumes for this configuration.void
Allows for enivironment variables to be set on the container at startupvoid
setExposedPorts
(List<String> ports) Allows a set of ports to be exposed inside the container before startup.
-
Method Details
-
setEnvs
Allows for enivironment variables to be set on the container at startup- Parameters:
envs
-
-
getEnvs
Returns the list of specified Keys and Values for the envs desired to be set- Returns:
- envs
-
getVolumes
List<IDockerVolume> getVolumes()Lists all the provisioned/binded volumes for this configuration.- Returns:
-
getVolumeByTag
Get the volume by the tag it is known as.- Parameters:
volumeTag
-- Returns:
- a volume from the configuration of a specfic tag.
-
setExposedPorts
Allows a set of ports to be exposed inside the container before startup. Ports are to be expressed for the conatiner and not the host (I.e. "8080/tcp"), as a random port will be exposed on the host, which can be obtained on the container object- Parameters:
ports
-
-
getExposedPorts
Retruns a list of exposed ports- Returns:
-