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

DockerBuildStep

~~open~~ ~~class~~ ~~DockerBuildStep~~ : ~~BuildStep~~

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

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

Constructors

DockerBuildStep

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

DockerBuildStep

fun DockerBuildStep()

Types

Source

sealed class Source : CompoundParam<DockerBuildStep.Source>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

conditions

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

Configures build step conditions

content

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

Use Dockerfile content

copyParamsTo

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

Copies parameters of this object to the specified target

create

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): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

path

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

Sets filesystem path to Dockerfile

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

url

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

Sets Dockerfile URL

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

commandArgs

var commandArgs: <ERROR CLASS>

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

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

contextDir

var contextDir: <ERROR CLASS>

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

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

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.

name

var name: String

Build step name

namesAndTags

var namesAndTags: <ERROR CLASS>

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

params