orca-api/com.netflix.spinnaker.orca.api.pipeline/SkippableTask

SkippableTask

A skippable task can be configured via properties to go directly from NOT_STARTED to SKIPPED. By default, the property name is:

tasks.$taskId.enabled

where `taskId` corresponds to the simple class name (without the package) with a lower case first character. For example, a skippable class `com.foo.DummySkippableTask` could be disabled via property

tasks.dummySkippableTask.enabled

public interface SkippableTask implements Task

Functions

aliases

A collection of known aliases.

Collection<String> aliases()

execute

Execute the business logic of the task, using the provided stage execution state.

@Nonnull()

abstract TaskResult execute(StageExecution stage)

getExtensionClass

Class<? extends SpinnakerExtensionPoint> getExtensionClass()

getPluginId

String getPluginId()

isEnabledPropertyName

String isEnabledPropertyName()

static String isEnabledPropertyName(String name)

onCancel

Behavior to be called on Task cancellation.

This method should be used if you need to perform cleanup in response to the task being cancelled before it was able to complete.

void onCancel(StageExecution stage)

onTimeout

Behavior to be called on Task timeout.

This method should be used if you need to perform any cleanup operations in response to the task being aborted after taking too long to complete.

@Nullable()

TaskResult onTimeout(StageExecution stage)

SkippableTask

See also

Functions