StepConfiguration (io.github.cdklabs:projen 0.80.15 API)

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

CheckoutOptions, DownloadArtifactOptions, JobStep, JobStepConfiguration, SetupGitIdentityOptions, Step, UploadArtifactOptions

All Known Implementing Classes:

CheckoutOptions.Jsii$Proxy, DownloadArtifactOptions.Jsii$Proxy, JobStep.Jsii$Proxy, JobStepConfiguration.Jsii$Proxy, SetupGitIdentityOptions.Jsii$Proxy, Step.Jsii$Proxy, StepConfiguration.Jsii$Proxy, UploadArtifactOptions.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.112Z")
@Stability(Experimental)
public interface StepConfiguration
extends software.amazon.jsii.JsiiSerializable
```
(experimental) Fields that describe the How, Why, When, and Who of a Step.
These fields can have none present, but can be present on every Step, and have no effect on one another.
This stands in contrast to the Command (non-Configuration) fields, which are mutually exclusive, and describe the What.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`StepConfiguration.Builder`	A builder for `StepConfiguration`
`static class`	`StepConfiguration.Jsii$Proxy`	An implementation for `StepConfiguration`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`static StepConfiguration.Builder`	`builder()`
`default Map<String,String>`	`getEnv()`	(experimental) Sets environment variables for steps to use in the runner environment.
`default String`	`getId()`	(experimental) A unique identifier for the step.
`default String`	`getIfValue()`	(experimental) You can use the if conditional to prevent a job from running unless a condition is met.
`default String`	`getName()`	(experimental) A name for your step to display on GitHub.
`default String`	`getWorkingDirectory()`	(experimental) Specifies a working directory for a step.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getEnv
```
@Stability(Experimental)
@Nullable
default Map<String,String> getEnv()
```
    (experimental) Sets environment variables for steps to use in the runner environment.
    You can also set environment variables for the entire workflow or a job.
  - getId
```
@Stability(Experimental)
@Nullable
default String getId()
```
    (experimental) A unique identifier for the step.
    You can use the id to reference the step in contexts.
  - getIfValue
```
@Stability(Experimental)
@Nullable
default String getIfValue()
```
    (experimental) You can use the if conditional to prevent a job from running unless a condition is met.
    You can use any supported context and expression to create a conditional.
  - getName
```
@Stability(Experimental)
@Nullable
default String getName()
```
    (experimental) A name for your step to display on GitHub.
  - getWorkingDirectory
```
@Stability(Experimental)
@Nullable
default String getWorkingDirectory()
```
    (experimental) Specifies a working directory for a step.
    Overrides a job's working directory.
  - builder
```
@Stability(Experimental)
static StepConfiguration.Builder builder()
```
    Returns:
    
    a StepConfiguration.Builder of StepConfiguration