Package software.amazon.awscdk.services.codepipeline

Interface GitPullRequestFilter

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GitPullRequestFilter.Jsii$Proxy
@Generated(value="jsii-pacmak/1.110.0 (build 336b265)", date="2025-04-22T23:08:09.265Z") @Stability(Stable) public interface GitPullRequestFilter extends software.amazon.jsii.JsiiSerializable
Git pull request filter for trigger.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 GitPullRequestFilter gitPullRequestFilter = GitPullRequestFilter.builder()
         .branchesExcludes(List.of("branchesExcludes"))
         .branchesIncludes(List.of("branchesIncludes"))
         .events(List.of(GitPullRequestEvent.OPEN))
         .filePathsExcludes(List.of("filePathsExcludes"))
         .filePathsIncludes(List.of("filePathsIncludes"))
         .build();

  • Method Details

    • getBranchesExcludes

      @Stability(Stable) @Nullable default List<String> getBranchesExcludes()
      The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.

      You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes.

      Maximum length of this array is 8.

      Default: - no branches.

    • getBranchesIncludes

      @Stability(Stable) @Nullable default List<String> getBranchesIncludes()
      The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.

      You can filter with glob patterns. The branchesExcludes takes priority over the branchesIncludes.

      Maximum length of this array is 8.

      Default: - no branches.

    • getEvents

      @Stability(Stable) @Nullable default List<GitPullRequestEvent> getEvents()
      The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

      Default: - all events.

    • getFilePathsExcludes

      @Stability(Stable) @Nullable default List<String> getFilePathsExcludes()
      The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.

      You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes.

      Maximum length of this array is 8.

      Default: - no filePaths.

    • getFilePathsIncludes

      @Stability(Stable) @Nullable default List<String> getFilePathsIncludes()
      The list of patterns of Git repository file paths that, when pull request events occurs, are to be included as criteria that starts the pipeline.

      You can filter with glob patterns. The filePathsExcludes takes priority over the filePathsIncludes.

      Maximum length of this array is 8.

      Default: - no filePaths.

    • builder

      @Stability(Stable) static GitPullRequestFilter.Builder builder()
      Returns:
      a GitPullRequestFilter.Builder of GitPullRequestFilter