Class Job.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- io.github.cdklabs.projen.github.workflows.Job.Jsii$Proxy
-
- All Implemented Interfaces:
CommonJobDefinition,Job,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- Job
@Stability(Experimental) @Internal public static final class Job.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements Job
An implementation forJob
-
-
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.Job
Job.Builder, Job.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(Job.Builder builder)Constructor that initializes the object based on literal property values passed by theJob.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)ObjectgetConcurrency()(experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.ContainerOptionsgetContainer()(experimental) A container to run any steps in a job that don't already specify a container.BooleangetContinueOnError()(experimental) Prevents a workflow run from failing when a job fails.JobDefaultsgetDefaults()(experimental) A map of default settings that will apply to all steps in the job.Map<String,String>getEnv()(experimental) A map of environment variables that are available to all steps in the job.ObjectgetEnvironment()(experimental) The environment that the job references.StringgetIfValue()(experimental) You can use the if conditional to prevent a job from running unless a condition is met.StringgetName()(experimental) The name of the job displayed on GitHub.List<String>getNeeds()(experimental) Identifies any jobs that must complete successfully before this job will run.Map<String,JobStepOutput>getOutputs()(experimental) A map of outputs for a job.JobPermissionsgetPermissions()(experimental) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.List<String>getRunsOn()(experimental) The type of machine to run the job on.GroupRunnerOptionsgetRunsOnGroup()(experimental) Github Runner Group selection options.Map<String,ContainerOptions>getServices()(experimental) Used to host service containers for a job in a workflow.List<JobStep>getSteps()(experimental) A job contains a sequence of tasks called steps.JobStrategygetStrategy()(experimental) A strategy creates a build matrix for your jobs.NumbergetTimeoutMinutes()(experimental) The maximum number of minutes to let a job run before GitHub automatically cancels it.ToolsgetTools()(experimental) Tools required for this job.inthashCode()
-
-
-
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 theJob.Builder.
-
-
Method Detail
-
getSteps
public final List<JobStep> getSteps()
Description copied from interface:Job(experimental) 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.
-
getContainer
public final ContainerOptions getContainer()
Description copied from interface:Job(experimental) 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:
getContainerin interfaceJob
-
getContinueOnError
public final Boolean getContinueOnError()
Description copied from interface:Job(experimental) 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:
getContinueOnErrorin interfaceJob
-
getDefaults
public final JobDefaults getDefaults()
Description copied from interface:Job(experimental) 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:
getDefaultsin interfaceJob
-
getEnv
public final Map<String,String> getEnv()
Description copied from interface:Job(experimental) 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.
-
getEnvironment
public final Object getEnvironment()
Description copied from interface:Job(experimental) The environment that the job references.All environment protection rules must pass before a job referencing the environment is sent to a runner.
- Specified by:
getEnvironmentin interfaceJob- See Also:
- https://docs.github.com/en/actions/reference/environments
-
getOutputs
public final Map<String,JobStepOutput> getOutputs()
Description copied from interface:Job(experimental) A map of outputs for a job.Job outputs are available to all downstream jobs that depend on this job.
- Specified by:
getOutputsin interfaceJob
-
getRunsOn
public final List<String> getRunsOn()
Description copied from interface:Job(experimental) 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"]
-
getRunsOnGroup
public final GroupRunnerOptions getRunsOnGroup()
Description copied from interface:Job(experimental) Github Runner Group selection options.- Specified by:
getRunsOnGroupin interfaceJob
-
getServices
public final Map<String,ContainerOptions> getServices()
Description copied from interface:Job(experimental) 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:
getServicesin interfaceJob
-
getTimeoutMinutes
public final Number getTimeoutMinutes()
Description copied from interface:Job(experimental) The maximum number of minutes to let a job run before GitHub automatically cancels it.Default: 360
- Specified by:
getTimeoutMinutesin interfaceJob
-
getTools
public final Tools getTools()
Description copied from interface:Job(experimental) Tools required for this job.Translates into
actions/setup-xxxsteps at the beginning of the job.
-
getPermissions
public final JobPermissions getPermissions()
Description copied from interface:CommonJobDefinition(experimental) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.Use
{ contents: READ }if your job only needs to clone code.This is intentionally a required field since it is required in order to allow workflows to run in GitHub repositories with restricted default access.
- Specified by:
getPermissionsin interfaceCommonJobDefinition- See Also:
- https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token
-
getConcurrency
public final Object getConcurrency()
Description copied from interface:CommonJobDefinition(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:
getConcurrencyin interfaceCommonJobDefinition
-
getIfValue
public final String getIfValue()
Description copied from interface:CommonJobDefinition(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:
getIfValuein interfaceCommonJobDefinition
-
getName
public final String getName()
Description copied from interface:CommonJobDefinition(experimental) The name of the job displayed on GitHub.- Specified by:
getNamein interfaceCommonJobDefinition
-
getNeeds
public final List<String> getNeeds()
Description copied from interface:CommonJobDefinition(experimental) 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:
getNeedsin interfaceCommonJobDefinition
-
getStrategy
public final JobStrategy getStrategy()
Description copied from interface:CommonJobDefinition(experimental) A strategy creates a build matrix for your jobs.You can define different variations to run each job in.
- Specified by:
getStrategyin interfaceCommonJobDefinition
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-