FreeDiskSpace

open class FreeDiskSpace : BuildFeature
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
}
}
}

See also

Constructors

Link copied to clipboard
fun FreeDiskSpace(init: FreeDiskSpace.() -> Unit)
Link copied to clipboard
fun FreeDiskSpace()

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): SingleDelegateProvider<Boolean>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<T>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): SingleDelegateProvider<Int>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
fun stringParameter(customName: String? = null): SingleDelegateProvider<String>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var failBuild: Boolean?

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

Link copied to clipboard
var id: String? = null

Build feature id, if not specified will be generated

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var requiredSpace: String?

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

Link copied to clipboard
var type: String

Build feature type