Job.Jsii$Proxy (io.github.cdklabs:projen 0.45.3 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - io.github.cdklabs.projen.github.workflows.Job.Jsii$Proxy

All Implemented Interfaces:: Job, software.amazon.jsii.JsiiSerializable

Enclosing interface:: Job

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

An implementation for Job

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 and Description
`protected`	`Jsii$Proxy(Job.Builder builder)` Constructor that initializes the object based on literal property values passed by the `Job.Builder`.
`protected`	`Jsii$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 and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Object`	`getConcurrency()` (experimental) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
`ContainerOptions`	`getContainer()` (experimental) A container to run any steps in a job that don't already specify a container.
`Boolean`	`getContinueOnError()` (experimental) Prevents a workflow run from failing when a job fails.
`JobDefaults`	`getDefaults()` (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.
`Object`	`getEnvironment()` (experimental) The environment that the job references.
`String`	`getIfValue()` (experimental) You can use the if conditional to prevent a job from running unless a condition is met.
`String`	`getName()` (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.
`JobPermissions`	`getPermissions()` (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.
`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.
`JobStrategy`	`getStrategy()` (experimental) A strategy creates a build matrix for your jobs.
`Number`	`getTimeoutMinutes()` (experimental) The maximum number of minutes to let a job run before GitHub automatically cancels it.
`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

Methods inherited from interface io.github.cdklabs.projen.github.workflows.Job
builder

- 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
  - getPermissions
```
public final JobPermissions getPermissions()
```
    Description copied from interface: Job
    
    (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:
    
    getPermissions in interface Job
    
    See Also:
    
    https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token
  - 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:
    // Example automatically generated from non-compiling source. May contain errors. ["ubuntu-latest"]
    Specified by:
    
    getRunsOn in interface Job
  - 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.
    
    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
    
    (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:
    
    getContainer in interface Job
  - 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:
    
    getContinueOnError in interface Job
  - 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:
    
    getDefaults in interface Job
  - 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.
    
    Specified by:
    
    getEnv in interface Job
  - 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:
    
    getEnvironment in interface Job
    
    See Also:
    
    https://docs.github.com/en/actions/reference/environments
  - getIfValue
```
public final String getIfValue()
```
    Description copied from interface: Job
    
    (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 Job
  - getName
```
public final String getName()
```
    Description copied from interface: Job
    
    (experimental) 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
    
    (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:
    
    getNeeds in interface Job
  - 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:
    
    getOutputs in interface Job
  - 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:
    
    getServices in interface Job
  - getStrategy
```
public final JobStrategy getStrategy()
```
    Description copied from interface: Job
    
    (experimental) 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
    
    (experimental) 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
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Job.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.cdklabs.projen.github.workflows.Job

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getPermissions

getRunsOn

getSteps

getConcurrency

getContainer

getContinueOnError

getDefaults

getEnv

getEnvironment

getIfValue

getName

getNeeds

getOutputs

getServices

getStrategy

getTimeoutMinutes

$jsii$toJson

equals

hashCode