TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/DockerBuildStep

DockerBuildStep

open class ~~DockerBuildStep~~ : BuildStep

fun BuildSteps.~~dockerBuild~~(init: DockerBuildStep.() -> Unit): DockerBuildStep

Deprecated

Deprecated, previously was used for Docker Build build step.

Replace with

DockerCommandStep

Deprecated, was used for Docker Build build step. Please use Docker command runner step instead.

See also

Constructors

DockerBuildStep

constructor(init: DockerBuildStep.() -> Unit)

constructor()

Types

sealed class Source : CompoundParam<DockerBuildStep.Source>

Properties

var commandArgs: String?

Additional arguments that will be passed to the 'build' command.

var conditions: BuildStepConditions

Optional collection of build step execution conditions

var contextDir: String?

If blank, the folder containing the Dockerfile will be used.

var enabled: Boolean

Specifies whether the step is enabled, true by default

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

var name: String

Build step name

var namesAndTags: String?

Newline-separated list of the image name:tag(s).

val params: List<Parameter>

var source: DockerBuildStep.Source?

Specifies the source of the Dockerfile

var type: String

Build step type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

fun content(init: DockerBuildStep.Source.Content.() -> Unit = {}): DockerBuildStep.Source.Content

Use Dockerfile content

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

fun intParameter(customName: String? = null): DelegateProvider<Int>

fun param(name: String, value: String)

Adds parameter with specified name and value

fun path(init: DockerBuildStep.Source.Path.() -> Unit = {}): DockerBuildStep.Source.Path

Sets filesystem path to Dockerfile

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

open override fun toString(): String

fun url(init: DockerBuildStep.Source.Url.() -> Unit = {}): DockerBuildStep.Source.Url

Sets Dockerfile URL

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer