Package io.github.cdklabs.cdkpipelines.github

Class JobStep.Jsii$Proxy

  • All Implemented Interfaces:
    JobStep, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    JobStep
    @Stability(Stable)
@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

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

    • 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

      • getContinueOnError

        public final Boolean getContinueOnError()
        Description copied from interface: JobStep
        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 JobStep

      • getEnv

        public final Map<String,​String> getEnv()
        Description copied from interface: JobStep
        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

      • getId

        public final String getId()
        Description copied from interface: JobStep
        A unique identifier for the step.

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

        Specified by:
        getId in interface JobStep

      • getIfValue

        public final String getIfValue()
        Description copied from interface: JobStep
        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

      • getName

        public final String getName()
        Description copied from interface: JobStep
        A name for your step to display on GitHub.
        Specified by:
        getName in interface JobStep

      • getRun

        public final String getRun()
        Description copied from interface: JobStep
        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 JobStep

      • getTimeoutMinutes

        public final Number getTimeoutMinutes()
        Description copied from interface: JobStep
        The maximum number of minutes to run the step before killing the process.
        Specified by:
        getTimeoutMinutes in interface JobStep

      • getUses

        public final String getUses()
        Description copied from interface: JobStep
        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 JobStep

      • getWith

        public final Map<String,​Object> getWith()
        Description copied from interface: JobStep
        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 JobStep

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object