cli/foundry.cli.buildkite/NestedBlockStepClass

NestedBlockStepClass

@Serializable

data class NestedBlockStepClass( val allowDependencyFailure: Boolean? = null, val block: Block? = null, val blockedState: BlockedState? = null, val branches: SimpleStringValue? = null, val dependsOn: DependsOn? = null, val fields: List<FieldElement>? = null, val id: String? = null, val identifier: String? = null, val stepIf: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val prompt: String? = null, val type: NestedBlockStepType? = null, val input: Input? = null, val agents: Agents? = null, val artifactPaths: SimpleStringValue? = null, val cancelOnBuildFailing: Boolean? = null, val command: Commands? = null, val commands: Commands? = null, val concurrency: Long? = null, val concurrencyGroup: String? = null, val concurrencyMethod: ConcurrencyMethod? = null, val env: Map<String, String>? = null, val matrix: MatrixUnion? = null, val notify: List<Notification>? = null, val parallelism: Long? = null, val plugins: Plugins? = null, val priority: Long? = null, val retry: Retry? = null, val signature: Signature? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val timeoutInMinutes: Long? = null, val script: ScriptStep? = null, val continueOnFailure: Boolean? = null, val wait: Wait? = null, val waiter: Wait? = null, val async: Boolean? = null, val build: Build? = null, val trigger: Trigger? = null, val group: String? = null, val steps: List<Step>? = null) : Keyable(source)

Waits for previous steps to pass before continuing

Constructors

constructor( allowDependencyFailure: Boolean? = null, block: Block? = null, blockedState: BlockedState? = null, branches: SimpleStringValue? = null, dependsOn: DependsOn? = null, fields: List<FieldElement>? = null, id: String? = null, identifier: String? = null, stepIf: String? = null, key: String? = null, label: String? = null, name: String? = null, prompt: String? = null, type: NestedBlockStepType? = null, input: Input? = null, agents: Agents? = null, artifactPaths: SimpleStringValue? = null, cancelOnBuildFailing: Boolean? = null, command: Commands? = null, commands: Commands? = null, concurrency: Long? = null, concurrencyGroup: String? = null, concurrencyMethod: ConcurrencyMethod? = null, env: Map<String, String>? = null, matrix: MatrixUnion? = null, notify: List<Notification>? = null, parallelism: Long? = null, plugins: Plugins? = null, priority: Long? = null, retry: Retry? = null, signature: Signature? = null, skip: Skip? = null, softFail: SoftFail? = null, timeoutInMinutes: Long? = null, script: ScriptStep? = null, continueOnFailure: Boolean? = null, wait: Wait? = null, waiter: Wait? = null, async: Boolean? = null, build: Build? = null, trigger: Trigger? = null, group: String? = null, steps: List<Step>? = null)

Properties

agents

val agents: Agents? = null

allowDependencyFailure

@SerialName(value = "allow_dependency_failure")

val allowDependencyFailure: Boolean? = null

artifactPaths

@SerialName(value = "artifact_paths")

val artifactPaths: SimpleStringValue? = null

The glob path/s of artifacts to upload once this step has finished running

async

val async: Boolean? = null

Whether to continue the build without waiting for the triggered step to complete

block

val block: Block? = null

The label of the block step

blockedState

@SerialName(value = "blocked_state")

val blockedState: BlockedState? = null

The state that the build is set to when the build is blocked by this block step

branches

val branches: SimpleStringValue? = null

build

val build: Build? = null

Properties of the build that will be created when the step is triggered

cancelOnBuildFailing

@SerialName(value = "cancel_on_build_failing")

val cancelOnBuildFailing: Boolean? = null

command

val command: Commands? = null

The commands to run on the agent

commands

val commands: Commands? = null

The commands to run on the agent

concurrency

val concurrency: Long? = null

The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.

concurrencyGroup

@SerialName(value = "concurrency_group")

val concurrencyGroup: String? = null

A unique name for the concurrency group that you are creating with the concurrency attribute

concurrencyMethod

@SerialName(value = "concurrency_method")

val concurrencyMethod: ConcurrencyMethod? = null

Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.

continueOnFailure