Package io.github.cdklabs.projen.github.workflows

Class JobStep.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.workflows.JobStep.Jsii$Proxy

All Implemented Interfaces:

JobStep, JobStepConfiguration, Step, StepConfiguration, software.amazon.jsii.JsiiSerializable

Enclosing interface:

JobStep

@Stability(Experimental)
@Internal
public static final class JobStep.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements JobStep

An implementation for JobStep

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.github.workflows.JobStep

JobStep.Builder, JobStep.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(JobStep.Builder builder)	Constructor that initializes the object based on literal property values passed by the JobStep.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getContinueOnError()	(experimental) Prevents a job from failing when a step fails.
Map<String,String>	getEnv()	(experimental) Sets environment variables for steps to use in the runner environment.
String	getId()	(experimental) A unique identifier for the step.
String	getIfValue()	(experimental) You can use the if conditional to prevent a job from running unless a condition is met.
String	getName()	(experimental) A name for your step to display on GitHub.
String	getRun()	(experimental) Runs command-line programs using the operating system's shell.
Number	getTimeoutMinutes()	(experimental) The maximum number of minutes to run the step before killing the process.
String	getUses()	(experimental) Selects an action to run as part of a step in your job.
Map<String,Object>	getWith()	(experimental) A map of the input parameters defined by the action.
String	getWorkingDirectory()	(experimental) Specifies a working directory for a step.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(JobStep.Builder builder)

Constructor that initializes the object based on literal property values passed by the JobStep.Builder.

Method Detail

getRun

public final String getRun()

Description copied from interface: Step

(experimental) Runs command-line programs using the operating system's shell.

If you do not provide a name, the step name will default to the text specified in the run command.

Specified by:

getRun in interface Step

getUses

public final String getUses()

Description copied from interface: Step

(experimental) Selects an action to run as part of a step in your job.

An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.

Specified by:

getUses in interface Step

getWith

public final Map<String,Object> getWith()

Description copied from interface: Step

(experimental) A map of the input parameters defined by the action.

Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.

Specified by:

getWith in interface Step

getEnv

public final Map<String,String> getEnv()

Description copied from interface: JobStep

(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.

Specified by:

getEnv in interface JobStep

Specified by:

getEnv in interface StepConfiguration

getId

public final String getId()

Description copied from interface: JobStep

(experimental) A unique identifier for the step.

You can use the id to reference the step in contexts.

Specified by:

getId in interface JobStep

Specified by:

getId in interface StepConfiguration

getIfValue

public final String getIfValue()

Description copied from interface: JobStep

(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.

Specified by:

getIfValue in interface JobStep

Specified by:

getIfValue in interface StepConfiguration

getName

public final String getName()

Description copied from interface: JobStep

(experimental) A name for your step to display on GitHub.

Specified by:

getName in interface JobStep

Specified by:

getName in interface StepConfiguration

getWorkingDirectory

public final String getWorkingDirectory()

Description copied from interface: JobStep

(experimental) Specifies a working directory for a step.

Overrides a job's working directory.

Specified by:

getWorkingDirectory in interface JobStep

Specified by:

getWorkingDirectory in interface StepConfiguration

getContinueOnError

public final Boolean getContinueOnError()

Description copied from interface: JobStepConfiguration

(experimental) Prevents a job from failing when a step fails.

Set to true to allow a job to pass when this step fails.

Specified by:

getContinueOnError in interface JobStepConfiguration

getTimeoutMinutes

public final Number getTimeoutMinutes()

Description copied from interface: JobStepConfiguration

(experimental) The maximum number of minutes to run the step before killing the process.

Specified by:

getTimeoutMinutes in interface JobStepConfiguration

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object