Package io.github.cdklabs.projen.circleci

Interface Job

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Job.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.060Z")
@Stability(Experimental)
public interface Job
extends software.amazon.jsii.JsiiSerializable

(experimental) A Workflow is comprised of one or more uniquely named jobs.

Jobs are specified in the jobs map, see Sample 2.0 config.yml for two examples of a job map. The name of the job is the key in the map, and the value is a map describing the job. Each job consists of the job’s name as a key and a map as a value. A name should be case insensitive unique within a current jobs list.

See Also:

https://circleci.com/docs/2.0/configuration-reference/#job_name

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Job.Builder	A builder for Job
static class	Job.Jsii$Proxy	An implementation for Job

Method Summary

Modifier and Type	Method	Description
static Job.Builder	builder()
default List<Docker>	getDocker()
default Map<String,Object>	getEnvironment()	(experimental) A map of environment variable names and values.
String	getIdentifier()	(experimental) name of dynamic key *.
default Machine	getMachine()
default Macos	getMacos()
default Number	getParallelism()	(experimental) Number of parallel instances of this job to run (default: 1).
default Map<String,PipelineParameter>	getParameters()	(experimental) Parameters for making a job explicitly configurable in a workflow.
default String	getResourceClass()	(experimental) ResourceClass.
default String	getShell()	(experimental) Shell to use for execution command in all steps.
default List<Object>	getSteps()	(experimental) no type support here, for syntax {@see https://circleci.com/docs/2.0/configuration-reference/#steps}.
default String	getWorkingDirectory()	(experimental) In which directory to run the steps.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIdentifier

@Stability(Experimental)
@NotNull
String getIdentifier()

(experimental) name of dynamic key *.

getDocker

@Stability(Experimental)
@Nullable
default List<Docker> getDocker()

getEnvironment

@Stability(Experimental)
@Nullable
default Map<String,Object> getEnvironment()

(experimental) A map of environment variable names and values.

getMachine

@Stability(Experimental)
@Nullable
default Machine getMachine()

getMacos

@Stability(Experimental)
@Nullable
default Macos getMacos()

getParallelism

@Stability(Experimental)
@Nullable
default Number getParallelism()

(experimental) Number of parallel instances of this job to run (default: 1).

getParameters

@Stability(Experimental)
@Nullable
default Map<String,PipelineParameter> getParameters()

(experimental) Parameters for making a job explicitly configurable in a workflow.

getResourceClass

@Stability(Experimental)
@Nullable
default String getResourceClass()

(experimental) ResourceClass.

getShell

@Stability(Experimental)
@Nullable
default String getShell()

(experimental) Shell to use for execution command in all steps.

Can be overridden by shell in each step

getSteps

@Stability(Experimental)
@Nullable
default List<Object> getSteps()

(experimental) no type support here, for syntax {@see https://circleci.com/docs/2.0/configuration-reference/#steps}.

getWorkingDirectory

@Stability(Experimental)
@Nullable
default String getWorkingDirectory()

(experimental) In which directory to run the steps.

Will be interpreted as an absolute path. Default: ~/project

builder

@Stability(Experimental)
static Job.Builder builder()

Returns:

a Job.Builder of Job