Trigger

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

Example. VCS trigger which triggers builds only in the default branch

See also Vcs Trigger

triggers {
vcs {
branchFilter = "+:<default>"
}
}

Example. Schedule trigger executing once per day at 9AM

See also Schedule Trigger

triggers {
schedule {
schedulingPolicy = daily {
hour = 9
}
triggerBuild = always()
withPendingChangesOnly = false
}
}

Example. Retry build with build customization.

Retries a failed build with the same settings and the same revisions. See also Retry build trigger

triggers {
retryBuild {
attempts = 2
retryWithTheSameRevisions = true

enforceCleanCheckout = true
enforceCleanCheckoutForDependencies = true
buildParams {
param("param1", "value1")
param("param2", "%build.number%")
}
}
}

Inheritors

Constructors

Link copied to clipboard
constructor(init: Trigger.() -> Unit)

Creates a trigger and initializes it with the specified init block

constructor()

Properties

Link copied to clipboard

Parameters that are added to triggered builds

Link copied to clipboard

Specifies whether the trigger is enabled

Link copied to clipboard

Whether the build should be triggered with clean checkout

Link copied to clipboard

When the enforceCleanCheckout is set to true specifies whether the clean checkout should also be applied to all dependencies.

Link copied to clipboard
var id: String?

Trigger id, if not set will be generated

Link copied to clipboard
Link copied to clipboard

Trigger type

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard

Configures build parameters that are applied to triggered builds

Link copied to clipboard
fun clear()
Link copied to clipboard

Deletes all configured build parameters

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, 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(): Trigger

Creates an instance of this trigger 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): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
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