Package io.github.cdklabs.cdkpipelines.github

Class Job.Jsii$Proxy

  • All Implemented Interfaces:
    Job, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    Job
    @Stability(Stable)
@Internal
public static final class Job.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements Job
    An implementation for Job

    • 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​(Job.Builder builder)
        Constructor that initializes the object based on literal property values passed by the Job.Builder.

    • Method Detail

      • getRunsOn

        public final Object getRunsOn()
        Description copied from interface: Job
        The type of machine to run the job on.

        The machine can be either a GitHub-hosted runner or a self-hosted runner.

        Example: 

         ["ubuntu-latest"]
        Specified by:
        getRunsOn in interface Job

      • getSteps

        public final List<JobStep> getSteps()
        Description copied from interface: Job
        A job contains a sequence of tasks called steps.

        Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.

        Specified by:
        getSteps in interface Job

      • getConcurrency

        public final Object getConcurrency()
        Description copied from interface: Job
        (experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.

        A concurrency group can be any string or expression. The expression can use any context except for the secrets context.

        Specified by:
        getConcurrency in interface Job

      • getContainer

        public final ContainerOptions getContainer()
        Description copied from interface: Job
        A container to run any steps in a job that don't already specify a container.

        If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.

        Specified by:
        getContainer in interface Job

      • getContinueOnError

        public final Boolean getContinueOnError()
        Description copied from interface: Job
        Prevents a workflow run from failing when a job fails.

        Set to true to allow a workflow run to pass when this job fails.

        Specified by:
        getContinueOnError in interface Job

      • getDefaults

        public final JobDefaults getDefaults()
        Description copied from interface: Job
        A map of default settings that will apply to all steps in the job.

        You can also set default settings for the entire workflow.

        Specified by:
        getDefaults in interface Job

      • getEnv

        public final Map<String,​String> getEnv()
        Description copied from interface: Job
        A map of environment variables that are available to all steps in the job.

        You can also set environment variables for the entire workflow or an individual step.

        Specified by:
        getEnv in interface Job

      • getIfValue

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

      • getName

        public final String getName()
        Description copied from interface: Job
        The name of the job displayed on GitHub.
        Specified by:
        getName in interface Job

      • getNeeds

        public final List<String> getNeeds()
        Description copied from interface: Job
        Identifies any jobs that must complete successfully before this job will run.

        It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue.

        Specified by:
        getNeeds in interface Job

      • getOutputs

        public final Map<String,​String> getOutputs()
        Description copied from interface: Job
        A map of outputs for a job.

        Job outputs are available to all downstream jobs that depend on this job.

        Specified by:
        getOutputs in interface Job

      • getServices

        public final Map<String,​ContainerOptions> getServices()
        Description copied from interface: Job
        Used to host service containers for a job in a workflow.

        Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers.

        Specified by:
        getServices in interface Job

      • getStrategy

        public final JobStrategy getStrategy()
        Description copied from interface: Job
        A strategy creates a build matrix for your jobs.

        You can define different variations to run each job in.

        Specified by:
        getStrategy in interface Job

      • getTimeoutMinutes

        public final Number getTimeoutMinutes()
        Description copied from interface: Job
        The maximum number of minutes to let a job run before GitHub automatically cancels it.

        Default: 360

        Specified by:
        getTimeoutMinutes in interface Job

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