TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/FreeDiskSpace

FreeDiskSpace

fun BuildFeatures.freeDiskSpace(init: FreeDiskSpace.() -> Unit): FreeDiskSpace

Build feature ensuring certain free disk space on the agent before the build by deleting files managed by the TeamCity agent.

Example. Cleanup up to 10GB of disk space on the agent before every build. Fail build if it's not possible to provide required disk space.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        freeDiskSpace {
          requiredSpace = "10gb"
          failBuild = true
        }
Content copied to clipboard
    }
}

Constructors

FreeDiskSpace

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

constructor()

Properties

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

failBuild

var failBuild: Boolean?

Whether TeamCity should fail a build if sufficient disk space cannot be freed.

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

requiredSpace

var requiredSpace: String?

Amount of the free disk space to ensure. Without a suffix treated as bytes. Supported suffixes are: kb, mb, gb, tb.

type

var type: String

Build feature type

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

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

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature 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