PipelineStep

Handle

📦 Aspire.Hosting v13.4.0

interface PipelineStep {
  readonly dependsOnSteps: List<string>;
  readonly description: string;
  readonly name: string;
  readonly requiredBySteps: List<string>;
  readonly tags: List<string>;
  addTag(tag: string): void;
  dependsOn(stepName: string): void;
  requiredBy(stepName: string): void;
}

8 members

Properties

propertydependsOnStepsList<string>get

Gets or initializes the list of step names that this step depends on.

propertydescriptionstringget

Gets or initializes the description of the step.

propertynamestringget

Gets or initializes the unique name of the step.

propertyrequiredByStepsList<string>get

Gets or initializes the list of step names that require this step to complete before they can finish. This is used internally during pipeline construction and is converted to DependsOn relationships.

propertytagsList<string>get

Gets or initializes the list of tags that categorize this step.

Methods

methodaddTag

Adds a tag to the step.

addTag(tag: string): void

Parameters

tagstring

methoddependsOn

Adds a dependency on another step.

dependsOn(stepName: string): void

Parameters

stepNamestring

methodrequiredBy

Specifies that this step is required by another step. This creates the inverse relationship where the other step will depend on this step.

requiredBy(stepName: string): void

Parameters

stepNamestring