Package io.github.cdklabs.projen.gitlab

Interface TriggerInclude

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    TriggerInclude.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.136Z")
@Stability(Experimental)
public interface TriggerInclude
extends software.amazon.jsii.JsiiSerializable
    (experimental) References a local file or an artifact from another job to define the pipeline configuration.

    See Also:
    https://docs.gitlab.com/ee/ci/yaml/#triggerinclude

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      static TriggerInclude.Builder builder()  
      default String getArtifact()
      (experimental) Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.
      default String getFile()
      (experimental) Relative path from repository root (/) to the pipeline configuration YAML file.
      default String getJob()
      (experimental) Job name which generates the artifact.
      default String getLocal()
      (experimental) Relative path from local repository root (/) to the local YAML file to define the pipeline configuration.
      default String getProject()
      (experimental) Path to another private project under the same GitLab instance, like group/project or group/sub-group/project.
      default String getRef()
      (experimental) Branch/Tag/Commit hash for the target project.
      default String getTemplate()
      (experimental) Name of the template YAML file to use in the pipeline configuration.

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Method Detail

      • getArtifact

        @Stability(Experimental)
@Nullable
default String getArtifact()
        (experimental) Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.

      • getFile

        @Stability(Experimental)
@Nullable
default String getFile()
        (experimental) Relative path from repository root (/) to the pipeline configuration YAML file.

      • getJob

        @Stability(Experimental)
@Nullable
default String getJob()
        (experimental) Job name which generates the artifact.

      • getLocal

        @Stability(Experimental)
@Nullable
default String getLocal()
        (experimental) Relative path from local repository root (/) to the local YAML file to define the pipeline configuration.

      • getProject

        @Stability(Experimental)
@Nullable
default String getProject()
        (experimental) Path to another private project under the same GitLab instance, like group/project or group/sub-group/project.

      • getRef

        @Stability(Experimental)
@Nullable
default String getRef()
        (experimental) Branch/Tag/Commit hash for the target project.

      • getTemplate

        @Stability(Experimental)
@Nullable
default String getTemplate()
        (experimental) Name of the template YAML file to use in the pipeline configuration.