Package io.github.cdklabs.projen.gitlab

Class Include.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Include>
    Enclosing interface:
    Include
    @Stability(Experimental)
public static final class Include.Builder
extends Object
implements software.amazon.jsii.Builder<Include>
    A builder for Include

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • file

        @Stability(Experimental)
public Include.Builder file​(List<String> file)
        Sets the value of Include.getFile()
        Parameters:
        file - Files from another private project on the same GitLab instance. You can use file in combination with project only.
        Returns:
        this

      • local

        @Stability(Experimental)
public Include.Builder local​(String local)
        Sets the value of Include.getLocal()
        Parameters:
        local - Relative path from local repository root (/) to the yaml/yml file template. The file must be on the same branch, and does not work across git submodules.
        Returns:
        this

      • project

        @Stability(Experimental)
public Include.Builder project​(String project)
        Sets the value of Include.getProject()
        Parameters:
        project - Path to the project, e.g. group/project, or group/sub-group/project.
        Returns:
        this

      • ref

        @Stability(Experimental)
public Include.Builder ref​(String ref)
        Sets the value of Include.getRef()
        Parameters:
        ref - Branch/Tag/Commit-hash for the target project.
        Returns:
        this

      • remote

        @Stability(Experimental)
public Include.Builder remote​(String remote)
        Sets the value of Include.getRemote()
        Parameters:
        remote - URL to a yaml/yml template file using HTTP/HTTPS.
        Returns:
        this

      • rules

        @Stability(Experimental)
public Include.Builder rules​(List<? extends IncludeRule> rules)
        Sets the value of Include.getRules()
        Parameters:
        rules - Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
        Returns:
        this

      • template

        @Stability(Experimental)
public Include.Builder template​(String template)
        Sets the value of Include.getTemplate()
        Parameters:
        template - Use a .gitlab-ci.yml template as a base, e.g. Nodejs.gitlab-ci.yml.
        Returns:
        this

      • build

        @Stability(Experimental)
public Include build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<Include>
        Returns:
        a new instance of Include
        Throws:
        NullPointerException - if any required attribute was not provided