An id of a TeamCity entity. It appears in the web UI and is used in urls. If the entity has a uuid specified, then the id can be changed at any time. If uuid is omitted, then TeamCity treats an entity with a changed id as a new entity, all data associated with the old entity will be lost (e.g. a build history, a commit graph).

IdeaDuplicates

open class IdeaDuplicates : IdeaSettingsBasedRunner

The Duplicates Finder (Java) build runner is intended for catching similar code fragments and providing a report on discovered repetitive blocks of Java code.

IdeaInspections

open class IdeaInspections : IdeaSettingsBasedRunner

The Inspections (IntelliJ IDEA) build runner is intended to run code analysis based on IntelliJ IDEA inspections for your project.

IdeaRunner

open class IdeaRunner : IdeaSettingsBasedRunner

IntelliJ IDEA Project build runner allows you to build a project created in IntelliJ IDEA

IdeaSettingsBasedRunner

abstract class IdeaSettingsBasedRunner : BuildStep

IdGenerator

class IdGenerator

IdOwner

interface IdOwner

KubernetesCloudImage

open class KubernetesCloudImage : CloudImage

Definition of a cloud image for a cloud profile agent cloud profile for Kubernetes in a project.

KubernetesCloudProfile

open class KubernetesCloudProfile : CloudProfile

Definition of an agent cloud profile for Kubernetes in a project.

MatrixFeature

open class MatrixFeature : BuildFeature

The Matrix Builds feature allows you to define a build configuration with different sets of parameters/parameter values. Running this build configuration creates a batch of separate builds, each running its own parameter set.

Options

class Options : Parametrized

ParallelStageImpl

class ParallelStageImpl(val project: Project?) : CompoundStageImpl, CompoundStage, DependencyConstructor

Parameter

data class Parameter( val name: String, val value: String, val spec: ParameterSpec? = null)

Build parameter

ParameterDelegate

abstract class ParameterDelegate<T>(val paramName: String)

ParameterDisplay

enum ParameterDisplay : Enum<ParameterDisplay>

Specifies how parameter is shown in the Run Custom Build dialog

ParameterRef

class ParameterRef(val name: String)

Reference to a parameter

ParameterSpec

sealed class ParameterSpec

Parameter specification

ParameterSpecCheckbox

class ParameterSpecCheckbox( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean = false, val checkedValue: String? = null, val uncheckedValue: String? = null) : ParameterSpec

ParameterSpecFreeForm

class ParameterSpecFreeForm(val type: String, val arguments: Map<String, String> = linkedMapOf()) : ParameterSpec

ParameterSpecPassword

class ParameterSpecPassword( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean) : ParameterSpec

ParameterSpecRegex

class ParameterSpecRegex( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean = false, val regex: String = "", val validationMessage: String = "") : ParameterSpec

ParameterSpecRemote

open class ParameterSpecRemote( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean = false, val remoteType: String = "", val params: Map<String, String>) : ParameterSpec

ParameterSpecSelect

class ParameterSpecSelect( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean = false, val allowMultiple: Boolean = false, val valueSeparator: String = ",", val options: List<Any>) : ParameterSpec

ParameterSpecText

class ParameterSpecText( val label: String = "", val description: String = "", val display: ParameterDisplay = ParameterDisplay.NORMAL, val readOnly: Boolean = false, val allowEmpty: Boolean = true) : ParameterSpec

Parametrized

open class Parametrized

ParametrizedWithType

open class ParametrizedWithType : Parametrized, Validatable

Allows to add parameters to project, build configuration, or template

Project

open class Project : Validatable, IdOwner

Represents TeamCity project.

ProjectChartsOrder

open class ProjectChartsOrder(init: ChartsOrder.() -> Unit = {}) : ChartsOrder

A project feature for specifying project-level Charts order.

ProjectCustomChart

open class ProjectCustomChart(init: CustomChart.() -> Unit = {}) : CustomChart

A project-level Custom Chart

ProjectFeature

open class ProjectFeature : Parametrized, Validatable

Represents project-level feature

ProjectFeatures

class ProjectFeatures : Validatable

Collection of features in a project

PropInitOnceDelegate

open class PropInitOnceDelegate<T>(val instance: T)

Can be specified as a delegate for some property. Collects all initializers for such properties but does not call them right there. Instead all initializers are called inside applyAllInitFunctions

PublishMode

enum PublishMode : Enum<PublishMode>

This class is used to describe condition for artifact publishing at the end of the build

RelativeId

data class RelativeId(val relativeId: String) : Id

Entity id relative to the project where versioned settings were enabled. When DSL executed the id of the project with enabled versioned settings is prepended to all relative ids. Can be used only in DSL generated with the 'Generate portable DSL scripts' option enabled.

RemoteParameter

open class RemoteParameter : Parametrized, Validatable

Represents TeamCity Remote Parameter. Use concrete remote parameter classes instead of this class.

Requirement

data class Requirement( val type: RequirementType, val param: String, val value: String? = null, val id: String? = null)

An agent requirement, use methods in Requirements class to create it

Requirements

open class Requirements

Collection of agent requirements in build configuration or template.

RequirementType

enum RequirementType : Enum<RequirementType>

ReuseBuilds

enum ReuseBuilds : Enum<ReuseBuilds>

Reuse builds mode for snapshot dependencies

SequentialStageImpl

class SequentialStageImpl(val project: Project?) : CompoundStageImpl, CompoundStage, DependencyConstructor

SharedResource

open class SharedResource : ProjectFeature

Adds a Shared Resource project feature which allows limiting concurrently running builds using a shared resource. Note that a shared should be defined in project settings and then enabled in reguired build configurations.

SharedResources

open class SharedResources : BuildFeature

Adds a Shared Resource build feature which allows limiting concurrently running builds using a shared resource. Note that corrensponding Shared Resources project feature should be defined.

Single

class Single(val project: Project?, val buildType: BuildType) : AbstractStage, Stage, DependencyConstructor

SingleDelegateProvider

class SingleDelegateProvider<T>(val customParamName: String? = null, val mapping: Map<T, String?>? = null)

SingleParamDelegate

class SingleParamDelegate<T>(paramName: String, val mapping: Map<T, String?>? = null) : ParameterDelegate<T>

SnapshotDependency

class SnapshotDependency

TeamCity snapshot dependency.

SnapshotDependencyOptions

typealias SnapshotDependencyOptions = SnapshotDependency.() -> Unit

interface Stage

object StageFactory

annotation class TeamCityDsl

Template

open class Template : BuildTypeSettings, Validatable

Represents TeamCity build template.

Trigger

open class Trigger : Parametrized, Validatable

Represents TeamCity build trigger. Use concrete trigger classes such as VcsTrigger instead of this class.

TriggerBuildParameters

class TriggerBuildParameters : ParametrizedWithType

Set of build parameters that are added to builds triggered by a trigger.

Triggers

class Triggers : Validatable

Collection of build triggers in build configuration or template.

Validatable

interface Validatable

VcsRoot

open class VcsRoot : Parametrized, Validatable, IdOwner

A base class representing TeamCity VCS root.

VcsRootEntry

data class VcsRootEntry(val root: IdOwner, val checkoutRules: List<String>)

VcsRootRefs

open class VcsRootRefs(vcsRoot: VcsRoot)

Provides methods for creating references to VCS related properties

VcsSettings

class VcsSettings

Contains settings from the Version Control Settings tab of build configuration or template.

VMwareVSphereCloudImage

open class VMwareVSphereCloudImage : CloudImage

Definition of a cloud image for a cloud profile agent cloud profile for VMware vSphere and vCenter in a project.

VMwareVSphereCloudProfile

open class VMwareVSphereCloudProfile : CloudProfile

Definition of an agent cloud profile for VMware vSphere and vCenter in a project.

Functions

amazonEC2CloudImage

fun ProjectFeatures.amazonEC2CloudImage(init: AmazonEC2CloudImage.() -> Unit = {})

Definition of a cloud image for a cloud profile agent cloud profile for AWS EC2 in a project.

amazonEC2CloudProfile

fun ProjectFeatures.amazonEC2CloudProfile(init: AmazonEC2CloudProfile.() -> Unit = {})

Definition of an agent cloud profile for AWS EC2 in a project.

branchRemoteRun

fun Triggers.branchRemoteRun(init: BranchRemoteRunTrigger.() -> Unit = {})

Adds a Branch Remote Run Trigger which triggers a new personal build each time TeamCity detects changes in particular branches

buildTypeChartsOrder

fun ProjectFeatures.buildTypeChartsOrder(init: ChartsOrder.() -> Unit = {})

Adds a project feature for specifying build-configuration-level Charts order.

buildTypeCustomChart

fun ProjectFeatures.buildTypeCustomChart(init: CustomChart.() -> Unit = {})

Adds a build-configuration-level Custom Chart

copy

inline fun <T : BuildFeature> T.copy(): T

Copies the receiver build feature.

inline fun <T : BuildStep> T.copy(): T

Copies the receiver build step.

inline fun <T : BuildType> T.copy(): T

Copies the receiver buildType

inline fun <T : ProjectFeature> T.copy(): T

Copies the receiver project feature. if the receiver doesn't have a default constructor.

inline fun <T : Project> T.copy(): T

Copies the receiver project

inline fun <T : Template> T.copy(): T

Copies the receiver template

inline fun <T : Trigger> T.copy(): T

Copies the receiver trigger.

inline fun <T : VcsRoot> T.copy(): T

Copies the receiver VCS root.

fun ArtifactDependency.copy(): ArtifactDependency

Copies the receiver artifact dependency

fun BuildFeatures.copy(): BuildFeatures

Copies the receiver build features

fun BuildSteps.copy(): BuildSteps

Copies the receiver build steps

fun Cleanup.copy(): Cleanup

Copies the receiver cleanup

fun Dependencies.copy(): Dependencies

Copies the receiver dependencies

fun Dependency.copy(): Dependency

Copies the receiver dependency

fun FailureConditions.copy(): FailureConditions

Copies the receiver failure conditions

fun ProjectFeatures.copy(): ProjectFeatures

Copies the receiver project features

fun Requirements.copy(): Requirements

Copies the receiver requirements

fun SnapshotDependency.copy(): SnapshotDependency

Copies the receiver snapshot dependency

fun Triggers.copy(): Triggers

Copies the receiver triggers

fun VcsSettings.copy(): VcsSettings

Copies the receiver vcs settings

inline fun <T : BuildFeature> T.copy(block: T.() -> Unit): T

Copies the receiver build feature and initialize it with the specified block.

inline fun <T : BuildStep> T.copy(block: T.() -> Unit): T

Copies the receiver build step and initialize it with the specified block.

inline fun <T : BuildType> T.copy(block: T.() -> Unit): T

Copies the receiver buildType and initialize it with the specified block.

inline fun <T : ProjectFeature> T.copy(block: T.() -> Unit): T

Copies the receiver project feature and initialize it with the specified block.

inline fun <T : Project> T.copy(block: T.() -> Unit): T

Copies the receiver project and initialize it with the specified block.

inline fun <T : Template> T.copy(block: T.() -> Unit): T

Copies the receiver template and initialize it with the specified block.

inline fun <T : Trigger> T.copy(block: T.() -> Unit): T

Copies the receiver trigger and initialize it with the specified block.

inline fun <T : VcsRoot> T.copy(block: T.() -> Unit): T

Copies the receiver VCS root and initialize it with the specified block.

copySettingsTo

fun <T : BuildTypeSettings> T.copySettingsTo(target: T): T

Copies the receiver build settings to the specified target

copyTo

fun <T : BuildFeature> T.copyTo(target: T): T

Copies the receiver build feature to the specified target build feature

fun <T : BuildStep> T.copyTo(target: T): T

Copies the receiver build step to the specified target build step

fun <T : BuildType> T.copyTo(target: T): T

Copies the receiver buildType to the specified target

fun <T : ProjectFeature> T.copyTo(target: T): T

Copies the receiver project feature to the specified target feature

fun <T : Project> T.copyTo(target: T): T

Copies the receiver project to the specified target

fun <T : Template> T.copyTo(target: T): T

Copies the receiver template to the specified target

fun <T : Trigger> T.copyTo(target: T): T

Copies the receiver trigger to the specified target trigger

fun <T : VcsRoot> T.copyTo(target: T): T

Copies the receiver VCS root to the specified target VCS root

fun BuildFeatures.copyTo(target: BuildFeatures): BuildFeatures

Copies the receiver build features to the specified target

fun BuildSteps.copyTo(target: BuildSteps): BuildSteps

Copies the receiver build steps to the specified target

fun Cleanup.copyTo(target: Cleanup): Cleanup

Copies the receiver cleanup to the specified target

fun Dependencies.copyTo(target: Dependencies): Dependencies

Copies the receiver dependencies to the specified target

fun FailureConditions.copyTo(target: FailureConditions): FailureConditions

Copies the receiver failure conditions to the specified target

fun ProjectFeatures.copyTo(target: ProjectFeatures): ProjectFeatures

Copies the receiver project features to the specified target

fun Requirements.copyTo(target: Requirements): Requirements

Copies the receiver requirements to the specified target

fun Triggers.copyTo(target: Triggers): Triggers

Copies the receiver triggers to the specified target

fun VcsSettings.copyTo(target: VcsSettings): VcsSettings

Copies the receiver vcs settings to the specified target

ideaDuplicates

fun BuildSteps.ideaDuplicates(init: IdeaDuplicates.() -> Unit = {})

The Duplicates Finder (Java) build runner is intended for catching similar code fragments and providing a report on discovered repetitive blocks of Java code.

ideaInspections

fun BuildSteps.ideaInspections(init: IdeaInspections.() -> Unit = {})

The Inspections (IntelliJ IDEA) build runner is intended to run code analysis based on IntelliJ IDEA inspections for your project.

ideaRunner

fun BuildSteps.ideaRunner(init: IdeaRunner.() -> Unit = {})

IntelliJ IDEA Project build runner allows you to build a project created in IntelliJ IDEA

kubernetesCloudImage

fun ProjectFeatures.kubernetesCloudImage(init: KubernetesCloudImage.() -> Unit = {})

Definition of a cloud image for a cloud profile agent cloud profile for Kubernetes in a project.

kubernetesCloudProfile

fun ProjectFeatures.kubernetesCloudProfile(init: KubernetesCloudProfile.() -> Unit = {})

Definition of an agent cloud profile for Kubernetes in a project.

matrix

fun BuildFeatures.matrix(init: MatrixFeature.() -> Unit = {})

prepareRelativeProject

fun prepareRelativeProject(project: Project)

project

fun project(project: Project)

fun project(init: Project.() -> Unit)

Defines TeamCity project

projectChartsOrder

fun ProjectFeatures.projectChartsOrder(init: ChartsOrder.() -> Unit = {})

Adds a project feature for specifying project-level Charts order.

projectCustomChart

fun ProjectFeatures.projectCustomChart(init: CustomChart.() -> Unit = {})

Adds a project-level Custom Chart

relativeIdCannotBeUsed

fun relativeIdCannotBeUsed(description: String, id: Id?): String

relativeIdInAbsoluteHierarchy

fun relativeIdInAbsoluteHierarchy(id: Id?): Boolean

reportRelativeIds

fun reportRelativeIds(project: Project)

fun reportRelativeIds(project: Project, rootProject: Boolean)

runPrivileged

fun <T> runPrivileged(function: () -> T): T

sequential

fun Project.sequential(block: CompoundStage.() -> Unit): CompoundStage

sharedResource

fun ProjectFeatures.sharedResource(init: SharedResource.() -> Unit)

sharedResources

fun BuildFeatures.sharedResources(init: SharedResources.() -> Unit = {})

Adds a Shared Resource build feature which allows limiting concurrently running builds using a shared resource. Note that corrensponding Shared Resources project feature should be defined.

toId

fun String.toId(prefix: String = ""): String

Creates a string satisfying requirements for entity id in TeamCity. Can be used to generate an id from a name.

vmwareVSphereCloudImage

fun ProjectFeatures.vmwareVSphereCloudImage(init: VMwareVSphereCloudImage.() -> Unit = {})

Definition of a cloud image for a cloud profile agent cloud profile for VMware vSphere and vCenter in a project.

vmwareVSphereCloudProfile

fun ProjectFeatures.vmwareVSphereCloudProfile(init: VMwareVSphereCloudProfile.() -> Unit = {})

Definition of an agent cloud profile for VMware vSphere and vCenter in a project.

Properties

checkMissingUuids

var checkMissingUuids: Boolean = false

Specifies whether a missing uuid should cause a validation error. If set to false (default) an omitted uuid is allowed and is later reconstructed by id of the entity.

ID_GENERATORS_FOR_TEMPLATES

val ID_GENERATORS_FOR_TEMPLATES: <ERROR CLASS>

val TQ: String

Used to escape triple quotes inside multi-line strings

version

var version: String?

Version of TeamCity in which kotlin code was generated.