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

Class Triggers.Jsii$Proxy

  • All Implemented Interfaces:
    Triggers, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    Triggers
    @Stability(Experimental)
@Internal
public static final class Triggers.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements Triggers
    An implementation for Triggers

    • 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​(Triggers.Builder builder)
        Constructor that initializes the object based on literal property values passed by the Triggers.Builder.

    • Method Detail

      • getCheckRun

        public final CheckRunOptions getCheckRun()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the check_run event occurs.
        Specified by:
        getCheckRun in interface Triggers

      • getCheckSuite

        public final CheckSuiteOptions getCheckSuite()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the check_suite event occurs.
        Specified by:
        getCheckSuite in interface Triggers

      • getCreate

        public final CreateOptions getCreate()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime someone creates a branch or tag, which triggers the create event.
        Specified by:
        getCreate in interface Triggers

      • getDelete

        public final DeleteOptions getDelete()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event.
        Specified by:
        getDelete in interface Triggers

      • getDeployment

        public final DeploymentOptions getDeployment()
        Description copied from interface: Triggers
        (experimental) 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 Triggers

      • getDeploymentStatus

        public final DeploymentStatusOptions getDeploymentStatus()
        Description copied from interface: Triggers
        (experimental) 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 Triggers

      • getFork

        public final ForkOptions getFork()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime when someone forks a repository, which triggers the fork event.
        Specified by:
        getFork in interface Triggers

      • getGollum

        public final GollumOptions getGollum()
        Description copied from interface: Triggers
        (experimental) Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.
        Specified by:
        getGollum in interface Triggers

      • getIssues

        public final IssuesOptions getIssues()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the issues event occurs.
        Specified by:
        getIssues in interface Triggers

      • getLabel

        public final LabelOptions getLabel()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the label event occurs.
        Specified by:
        getLabel in interface Triggers

      • getMergeGroup

        public final MergeGroupOptions getMergeGroup()
        Description copied from interface: Triggers
        (experimental) Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group.
        Specified by:
        getMergeGroup in interface Triggers

      • getMilestone

        public final MilestoneOptions getMilestone()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the milestone event occurs.
        Specified by:
        getMilestone in interface Triggers

      • getPageBuild

        public final PageBuildOptions getPageBuild()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event.
        Specified by:
        getPageBuild in interface Triggers

      • getProject

        public final ProjectOptions getProject()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the project event occurs.
        Specified by:
        getProject in interface Triggers

      • getPublicValue

        public final PublicOptions getPublicValue()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime someone makes a private repository public, which triggers the public event.
        Specified by:
        getPublicValue in interface Triggers

      • getPullRequestTarget

        public final PullRequestTargetOptions getPullRequestTarget()
        Description copied from interface: Triggers
        (experimental) 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 Triggers
        See Also:
        https://securitylab.github.com/research/github-actions-preventing-pwn-requests

      • getPush

        public final PushOptions getPush()
        Description copied from interface: Triggers
        (experimental) Runs your workflow when someone pushes to a repository branch, which triggers the push event.
        Specified by:
        getPush in interface Triggers

      • getRelease

        public final ReleaseOptions getRelease()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the release event occurs.
        Specified by:
        getRelease in interface Triggers

      • getRepositoryDispatch

        public final RepositoryDispatchOptions getRepositoryDispatch()
        Description copied from interface: Triggers
        (experimental) 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 Triggers

      • getStatus

        public final StatusOptions getStatus()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the status of a Git commit changes, which triggers the status event.
        Specified by:
        getStatus in interface Triggers

      • getWatch

        public final WatchOptions getWatch()
        Description copied from interface: Triggers
        (experimental) Runs your workflow anytime the watch event occurs.
        Specified by:
        getWatch in interface Triggers

      • getWorkflowDispatch

        public final WorkflowDispatchOptions getWorkflowDispatch()
        Description copied from interface: Triggers
        (experimental) 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 Triggers

      • getWorkflowRun

        public final WorkflowRunOptions getWorkflowRun()
        Description copied from interface: Triggers
        (experimental) 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 Triggers

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object