Package io.github.cdklabs.projen.github.workflows

Interface JobCallingReusableWorkflow

All Superinterfaces:

CommonJobDefinition, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobCallingReusableWorkflow.Jsii$Proxy

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

(experimental) A GitHub Workflow Job calling a reusable workflow.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JobCallingReusableWorkflow.Builder	builder()
default Object	getSecrets()	(experimental) When a job is used to call a reusable workflow, you can use secrets to provide a map of secrets that are passed to the called workflow.
String	getUses()	(experimental) The location and version of a reusable workflow file to run as a job.
default Map<String,Object>	getWith()	(experimental) When a job is used to call a reusable workflow, you can use with to provide a map of inputs that are passed to the called workflow.

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

getConcurrency, getIfValue, getName, getNeeds, getPermissions, getStrategy

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getUses

@Stability(Experimental)
@NotNull
String getUses()

(experimental) The location and version of a reusable workflow file to run as a job.

getSecrets

@Stability(Experimental)
@Nullable
default Object getSecrets()

(experimental) When a job is used to call a reusable workflow, you can use secrets to provide a map of secrets that are passed to the called workflow.

Use the 'inherit' keyword to pass all the calling workflow's secrets to the called workflow

getWith

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

(experimental) When a job is used to call a reusable workflow, you can use with to provide a map of inputs that are passed to the called workflow.

Allowed expression contexts: github, and needs.

builder

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

Returns:

a JobCallingReusableWorkflow.Builder of JobCallingReusableWorkflow