DockerPipelineConfiguration (Atlassian Bamboo 9.5.1 API)

All Superinterfaces:

ConvertibleFromConfig, OptionallyConvertibleFromConfig

All Known Implementing Classes:

DockerPipelineConfigurationImpl
```
public interface DockerPipelineConfiguration
extends OptionallyConvertibleFromConfig
```
Configuration of Docker pipeline for a single buildable entity (e.g. a job or an environment).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`@NotNull List<String>`	`getAdditionalArgs()`	Additional arguments for docker command.
`@NotNull List<DataVolume>`	`getDataVolumes()`	List of data volume mapping between host and container.
`@Nullable String`	`getImage()`	Docker image to be used for the Docker pipeline.
`boolean`	`isEnabled()`	Whether the Docker pipeline is enabled.
`void`	`setAdditionalArgs(@NotNull Iterable<String> additionalArgs)`
`void`	`setDataVolumes(@NotNull Iterable<DataVolume> dataVolumes)`
`void`	`setEnabled(boolean enabled)`
`void`	`setImage(@Nullable String image)`

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig
populateFromConfig, toConfiguration

Methods inherited from interface com.atlassian.bamboo.fieldvalue.OptionallyConvertibleFromConfig
isValid

- Method Detail
  - isEnabled
```
boolean isEnabled()
```
    Whether the Docker pipeline is enabled.
  - setEnabled
```
void setEnabled(boolean enabled)
```
  - getImage
```
@Nullable
@Nullable String getImage()
```
    Docker image to be used for the Docker pipeline. The value can be any valid image identifier accepted by Docker, in particular it can consist of registry information, namespace, image name and tag name.
    Example: localhost:5000/atlassian/docker-image:version-5
  - setImage
```
void setImage(@Nullable
              @Nullable String image)
```
  - getDataVolumes
```
@NotNull
@NotNull List<DataVolume> getDataVolumes()
```
    List of data volume mapping between host and container.
  - setDataVolumes
```
void setDataVolumes(@NotNull
                    @NotNull Iterable<DataVolume> dataVolumes)
```
  - getAdditionalArgs
```
@NotNull
@NotNull List<String> getAdditionalArgs()
```
    Additional arguments for docker command.
    
    Since:
    
    7.1
  - setAdditionalArgs
```
void setAdditionalArgs(@NotNull
                       @NotNull Iterable<String> additionalArgs)
```