TeamCity Kotlin DSL 2026.1/jetbrains.buildServer.configs.kotlin.pipelines/Job

Job

Represents a job within a TeamCity pipeline.

A job is a unit of work in a pipeline that performs a specific task, such as building, testing, or deploying. Jobs can have dependencies on other jobs, allowing for complex workflows.

The id and name are mandatory properties for a valid job (id can be omitted if it matches the class name).

Job settings are grouped into blocks:

steps() - configures the steps for the job
params() - configures job parameters
dependency() - defines job dependencies
outputFiles() - configures output files (share with jobs or publish as artifacts)
repositories() - configures VCS repositories for the job

Example. Basic job with build steps

job {
  id("build")
  name = "Build Application"

  steps {
    gradle {
      tasks = "clean build"
      buildFile = "build.gradle"
    }
  }
}

Example. Job with dependencies and parameters

job {
  id("build")
  name = "Deploy Application"

  params {
    param("env.DEPLOY_ENV", "production")
  }

  steps {
    script {
      scriptContent = "deploy.sh"
    }
  }

  dependency("build")
  dependency("test")
}

Constructors

Job

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

Creates a job and initializes it with the specified init block.

constructor()

Types

Dependency

class Dependency(val job: String, val files: List<String>? = null)

Represents a dependency on another job.

Properties

allowReuse

var allowReuse: Boolean?

Allow reuse

dependencies

val dependencies: MutableList<Job.Dependency>

Job dependencies

features

val features: PipelineFeatures

var id: String

integrations

val integrations: MutableList<JobIntegration>

Job integrations

jobArtifacts

val jobArtifacts: JobArtifacts

External job artifacts, artifact dependencies on build configurations outside this pipeline

name

var name: String

Job name

outputFiles

val outputFiles: OutputFiles

Job output files configuration

parallelism

var parallelism: Int?

Job parallelism determines parallelism level for this job

params

val params: ParametrizedWithType

Job parameters

repositories

val repositories: JobRepositories

Job repositories

requirements

val requirements: Requirements

Job agent requirements

steps

val steps: PipelineSteps

Functions

create

open fun create(): Job

Creates an instance of this job 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.

dependency

fun dependency(job: Job)

Adds a dependency on the specified job

fun dependency(jobId: String)

Adds a dependency on a job with the specified id.

fun dependency(job: Job, files: List<String>)

Adds a dependency on the specified job with a list of files

fun dependency(jobId: String, files: List<String>)

Adds a dependency on a job with the specified id and a list of files.

download