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

ContainerDeployer

open class ContainerDeployer : BuildStep

fun BuildSteps.containerDeployer(init: ContainerDeployer.() -> Unit): ContainerDeployer

A Container Deployer build step.

Example. Adds a Container Deployer with HTTPS enabled.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        containerDeployer {
            name = "My Container Deployer build step"
            targetUrl = "{hostname|IP}[:port]"
            containerType = ContainerDeployer.ContainerType.TOMCAT_8_X
            useHTTPS = true
            username = "username"
            password = "credentialsJSON:******"
            sourcePath = "path/to/war"
        }
Content copied to clipboard
    }
}

Constructors

ContainerDeployer

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

ContainerDeployer

fun ContainerDeployer()

Types

ContainerType

enum ContainerType : Enum<ContainerDeployer.ContainerType>

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

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

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

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

containerType

var containerType: <ERROR CLASS>

Default "Manager" web app must be deployed to target Tomcat. User must have role "manager-script".

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

params