DockerCreateContainer (gradle-docker-plugin 9.0.1 API)

com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer

class DockerCreateContainer
extends DockerExistingImage

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`DockerCreateContainer.1`
`static class`	`DockerCreateContainer.ExposedPort`
`static class`	`DockerCreateContainer.HealthCheckConfig`	Since: 6.7.0
`static class`	`DockerCreateContainer.HostConfig`	Since: 6.0.0

Properties Summary

Properties
Type	Name and description
`Property<Boolean>`	`attachStderr`
`Property<Boolean>`	`attachStdin`
`Property<Boolean>`	`attachStdout`
`ListProperty<String>`	`cmd`
`Property<String>`	`containerId` The ID of the container created.
`RegularFileProperty`	`containerIdFile` Output file containing the container ID of the container created.
`Property<String>`	`containerName`
`ListProperty<String>`	`entrypoint`
`MapProperty<String, String>`	`envVars`
`ListProperty<ExposedPort>`	`exposedPorts`
`DockerCreateContainer.HealthCheckConfig`	`healthCheck`
`DockerCreateContainer.HostConfig`	`hostConfig`
`Property<String>`	`hostName`
`Property<String>`	`image`
`Property<String>`	`ipv4Address`
`MapProperty<String, String>`	`labels`
`Property<String>`	`macAddress`
`ListProperty<String>`	`networkAliases`
`Property<String>`	`pid`
`Property<String>`	`platform` The target platform in the format `os[/arch[/variant]]`, for example `linux/s390x` or `darwin`.
`ListProperty<String>`	`portSpecs`
`Property<Boolean>`	`stdinOnce`
`Property<Boolean>`	`stdinOpen`
`Property<Boolean>`	`tty`
`Property<String>`	`user`
`ListProperty<String>`	`volumes`
`Property<String>`	`workingDir`

Constructor Summary

Constructors
Constructor and description
`DockerCreateContainer (ObjectFactory objectFactory)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`exposePorts(String internetProtocol, List<Integer> ports)`
	`void`	`runRemoteCommand()`
	`void`	`withEnvVar(String key, String value)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DockerExistingImage`	`targetImageId, targetImageId, targetImageId`
`class AbstractDockerRemoteApiTask`	`getDockerClient, getNextHandler, getRegistryAuthLocator, onComplete, onError, onNext, runRemoteCommand, start`

- Property Detail
  - @Input @Optional final Property<Boolean> attachStderr
  - @Input @Optional final Property<Boolean> attachStdin
  - @Input @Optional final Property<Boolean> attachStdout
  - @Input @Optional final ListProperty<String> cmd
  - @Internal final Property<String> containerId
    
    The ID of the container created. The value of this property requires the task action to be executed.
  - @OutputFile final RegularFileProperty containerIdFile
    
    Output file containing the container ID of the container created. Defaults to "$buildDir/.docker/$taskpath-containerId.txt". If path contains ':' it will be replaced by '_'.
  - @Input @Optional final Property<String> containerName
  - @Input @Optional final ListProperty<String> entrypoint
  - @Input @Optional final MapProperty<String, String> envVars
  - @Input final ListProperty<ExposedPort> exposedPorts
  - @Nested final DockerCreateContainer.HealthCheckConfig healthCheck
  - @Nested final DockerCreateContainer.HostConfig hostConfig
  - @Input @Optional final Property<String> hostName
  - @Input @Optional final Property<String> image
  - @Input @Optional final Property<String> ipv4Address
  - @Input @Optional final MapProperty<String, String> labels
  - @Input @Optional final Property<String> macAddress
  - @Input @Optional final ListProperty<String> networkAliases
  - @Input @Optional final Property<String> pid
  - @Input @Optional final Property<String> platform
    
    The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
    Since:
    7.1.0
  - @Input @Optional final ListProperty<String> portSpecs
  - @Input @Optional final Property<Boolean> stdinOnce
  - @Input @Optional final Property<Boolean> stdinOpen
  - @Input @Optional final Property<Boolean> tty
  - @Input @Optional final Property<String> user
  - @Input @Optional final ListProperty<String> volumes
  - @Input @Optional final Property<String> workingDir
- Constructor Detail
  - @Inject DockerCreateContainer(ObjectFactory objectFactory)
- Method Detail
  - void exposePorts(String internetProtocol, List<Integer> ports)
  - @Override void runRemoteCommand()
  - void withEnvVar(String key, String value)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class DockerCreateContainer

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Input @Optional final Property<Boolean> attachStderr

@Input @Optional final Property<Boolean> attachStdin

@Input @Optional final Property<Boolean> attachStdout

@Input @Optional final ListProperty<String> cmd

@Internal final Property<String> containerId

@OutputFile final RegularFileProperty containerIdFile

@Input @Optional final Property<String> containerName

@Input @Optional final ListProperty<String> entrypoint

@Input @Optional final MapProperty<String, String> envVars

@Input final ListProperty<ExposedPort> exposedPorts

@Nested final DockerCreateContainer.HealthCheckConfig healthCheck

@Nested final DockerCreateContainer.HostConfig hostConfig

@Input @Optional final Property<String> hostName

@Input @Optional final Property<String> image

@Input @Optional final Property<String> ipv4Address

@Input @Optional final MapProperty<String, String> labels

@Input @Optional final Property<String> macAddress

@Input @Optional final ListProperty<String> networkAliases

@Input @Optional final Property<String> pid

@Input @Optional final Property<String> platform

@Input @Optional final ListProperty<String> portSpecs

@Input @Optional final Property<Boolean> stdinOnce

@Input @Optional final Property<Boolean> stdinOpen

@Input @Optional final Property<Boolean> tty

@Input @Optional final Property<String> user

@Input @Optional final ListProperty<String> volumes

@Input @Optional final Property<String> workingDir

Constructor Detail

@Inject DockerCreateContainer(ObjectFactory objectFactory)

Method Detail

void exposePorts(String internetProtocol, List<Integer> ports)

@Override void runRemoteCommand()

void withEnvVar(String key, String value)