Package io.github.cdklabs.cdkpipelines.github

Class WorkflowTriggers.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.cdkpipelines.github.WorkflowTriggers.Jsii$Proxy

All Implemented Interfaces:

WorkflowTriggers, software.amazon.jsii.JsiiSerializable

Enclosing interface:

WorkflowTriggers

@Stability(Stable)
@Internal
public static final class WorkflowTriggers.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements WorkflowTriggers

An implementation for WorkflowTriggers

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.cdkpipelines.github.WorkflowTriggers

WorkflowTriggers.Builder, WorkflowTriggers.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(WorkflowTriggers.Builder builder)	Constructor that initializes the object based on literal property values passed by the WorkflowTriggers.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
CheckRunOptions	getCheckRun()	Runs your workflow anytime the check_run event occurs.
CheckSuiteOptions	getCheckSuite()	Runs your workflow anytime the check_suite event occurs.
CreateOptions	getCreate()	Runs your workflow anytime someone creates a branch or tag, which triggers the create event.
DeleteOptions	getDelete()	Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event.
DeploymentOptions	getDeployment()	Runs your workflow anytime someone creates a deployment, which triggers the deployment event.
DeploymentStatusOptions	getDeploymentStatus()	Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event.
ForkOptions	getFork()	Runs your workflow anytime when someone forks a repository, which triggers the fork event.
GollumOptions	getGollum()	Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.
IssueCommentOptions	getIssueComment()	Runs your workflow anytime the issue_comment event occurs.
IssuesOptions	getIssues()	Runs your workflow anytime the issues event occurs.
LabelOptions	getLabel()	Runs your workflow anytime the label event occurs.
MilestoneOptions	getMilestone()	Runs your workflow anytime the milestone event occurs.
PageBuildOptions	getPageBuild()	Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event.
ProjectOptions	getProject()	Runs your workflow anytime the project event occurs.
ProjectCardOptions	getProjectCard()	Runs your workflow anytime the project_card event occurs.
ProjectColumnOptions	getProjectColumn()	Runs your workflow anytime the project_column event occurs.
PublicOptions	getPublicValue()	Runs your workflow anytime someone makes a private repository public, which triggers the public event.
PullRequestOptions	getPullRequest()	Runs your workflow anytime the pull_request event occurs.
PullRequestReviewOptions	getPullRequestReview()	Runs your workflow anytime the pull_request_review event occurs.
PullRequestReviewCommentOptions	getPullRequestReviewComment()	Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event.
PullRequestTargetOptions	getPullRequestTarget()	This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does.
PushOptions	getPush()	Runs your workflow when someone pushes to a repository branch, which triggers the push event.
RegistryPackageOptions	getRegistryPackage()	Runs your workflow anytime a package is published or updated.
ReleaseOptions	getRelease()	Runs your workflow anytime the release event occurs.
RepositoryDispatchOptions	getRepositoryDispatch()	You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub.
List<CronScheduleOptions>	getSchedule()	You can schedule a workflow to run at specific UTC times using POSIX cron syntax.
StatusOptions	getStatus()	Runs your workflow anytime the status of a Git commit changes, which triggers the status event.
WatchOptions	getWatch()	Runs your workflow anytime the watch event occurs.
WorkflowDispatchOptions	getWorkflowDispatch()	You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow.
WorkflowRunOptions	getWorkflowRun()	This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.
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

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(WorkflowTriggers.Builder builder)

Constructor that initializes the object based on literal property values passed by the WorkflowTriggers.Builder.

Method Detail

getCheckRun

public final CheckRunOptions getCheckRun()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the check_run event occurs.

Specified by:

getCheckRun in interface WorkflowTriggers

getCheckSuite

public final CheckSuiteOptions getCheckSuite()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the check_suite event occurs.

Specified by:

getCheckSuite in interface WorkflowTriggers

getCreate

public final CreateOptions getCreate()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime someone creates a branch or tag, which triggers the create event.

Specified by:

getCreate in interface WorkflowTriggers

getDelete

public final DeleteOptions getDelete()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event.

Specified by:

getDelete in interface WorkflowTriggers

getDeployment

public final DeploymentOptions getDeployment()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime someone creates a deployment, which triggers the deployment event.

Deployments created with a commit SHA may not have a Git ref.

Specified by:

getDeployment in interface WorkflowTriggers

getDeploymentStatus

public final DeploymentStatusOptions getDeploymentStatus()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event.

Deployments created with a commit SHA may not have a Git ref.

Specified by:

getDeploymentStatus in interface WorkflowTriggers

getFork

public final ForkOptions getFork()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime when someone forks a repository, which triggers the fork event.

Specified by:

getFork in interface WorkflowTriggers

getGollum

public final GollumOptions getGollum()

Description copied from interface: WorkflowTriggers

Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.

Specified by:

getGollum in interface WorkflowTriggers

getIssueComment

public final IssueCommentOptions getIssueComment()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the issue_comment event occurs.

Specified by:

getIssueComment in interface WorkflowTriggers

getIssues

public final IssuesOptions getIssues()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the issues event occurs.

Specified by:

getIssues in interface WorkflowTriggers

getLabel

public final LabelOptions getLabel()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the label event occurs.

Specified by:

getLabel in interface WorkflowTriggers

getMilestone

public final MilestoneOptions getMilestone()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the milestone event occurs.

Specified by:

getMilestone in interface WorkflowTriggers

getPageBuild

public final PageBuildOptions getPageBuild()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event.

Specified by:

getPageBuild in interface WorkflowTriggers

getProject

public final ProjectOptions getProject()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the project event occurs.

Specified by:

getProject in interface WorkflowTriggers

getProjectCard

public final ProjectCardOptions getProjectCard()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the project_card event occurs.

Specified by:

getProjectCard in interface WorkflowTriggers

getProjectColumn

public final ProjectColumnOptions getProjectColumn()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the project_column event occurs.

Specified by:

getProjectColumn in interface WorkflowTriggers

getPublicValue

public final PublicOptions getPublicValue()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime someone makes a private repository public, which triggers the public event.

Specified by:

getPublicValue in interface WorkflowTriggers

getPullRequest

public final PullRequestOptions getPullRequest()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the pull_request event occurs.

Specified by:

getPullRequest in interface WorkflowTriggers

getPullRequestReview

public final PullRequestReviewOptions getPullRequestReview()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the pull_request_review event occurs.

Specified by:

getPullRequestReview in interface WorkflowTriggers

getPullRequestReviewComment

public final PullRequestReviewCommentOptions getPullRequestReviewComment()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event.

Specified by:

getPullRequestReviewComment in interface WorkflowTriggers

getPullRequestTarget

public final PullRequestTargetOptions getPullRequestTarget()

Description copied from interface: WorkflowTriggers

This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does.

This prevents executing unsafe workflow code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows you to do things like create workflows that label and comment on pull requests based on the contents of the event payload.

WARNING: The pull_request_target event is granted read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered.

Specified by:

getPullRequestTarget in interface WorkflowTriggers

See Also:

https://securitylab.github.com/research/github-actions-preventing-pwn-requests

getPush

public final PushOptions getPush()

Description copied from interface: WorkflowTriggers

Runs your workflow when someone pushes to a repository branch, which triggers the push event.

Specified by:

getPush in interface WorkflowTriggers

getRegistryPackage

public final RegistryPackageOptions getRegistryPackage()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime a package is published or updated.

Specified by:

getRegistryPackage in interface WorkflowTriggers

getRelease

public final ReleaseOptions getRelease()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the release event occurs.

Specified by:

getRelease in interface WorkflowTriggers

getRepositoryDispatch

public final RepositoryDispatchOptions getRepositoryDispatch()

Description copied from interface: WorkflowTriggers

You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub.

Specified by:

getRepositoryDispatch in interface WorkflowTriggers

getSchedule

public final List<CronScheduleOptions> getSchedule()

Description copied from interface: WorkflowTriggers

You can schedule a workflow to run at specific UTC times using POSIX cron syntax.

Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.

Specified by:

getSchedule in interface WorkflowTriggers

See Also:

https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07

getStatus

public final StatusOptions getStatus()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the status of a Git commit changes, which triggers the status event.

Specified by:

getStatus in interface WorkflowTriggers

getWatch

public final WatchOptions getWatch()

Description copied from interface: WorkflowTriggers

Runs your workflow anytime the watch event occurs.

Specified by:

getWatch in interface WorkflowTriggers

getWorkflowDispatch

public final WorkflowDispatchOptions getWorkflowDispatch()

Description copied from interface: WorkflowTriggers

You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow.

When the workflow runs, you can access the input values in the github.event.inputs context.

Specified by:

getWorkflowDispatch in interface WorkflowTriggers

getWorkflowRun

public final WorkflowRunOptions getWorkflowRun()

Description copied from interface: WorkflowTriggers

This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.

A workflow run is triggered regardless of the result of the previous workflow.

Specified by:

getWorkflowRun in interface WorkflowTriggers

$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