Class CommonJobDefinition.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- io.github.cdklabs.projen.github.workflows.CommonJobDefinition.Jsii$Proxy
-
- All Implemented Interfaces:
CommonJobDefinition,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- CommonJobDefinition
@Stability(Experimental) @Internal public static final class CommonJobDefinition.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CommonJobDefinition
An implementation forCommonJobDefinition
-
-
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.CommonJobDefinition
CommonJobDefinition.Builder, CommonJobDefinition.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(CommonJobDefinition.Builder builder)Constructor that initializes the object based on literal property values passed by theCommonJobDefinition.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.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.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.JobStrategygetStrategy()(experimental) A strategy creates a build matrix for your jobs.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(CommonJobDefinition.Builder builder)
Constructor that initializes the object based on literal property values passed by theCommonJobDefinition.Builder.
-
-
Method Detail
-
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
-
-