Class GitPullRequestFilter

Git pull request filter for trigger.

Inheritance

object

GitPullRequestFilter

Implements

IGitPullRequestFilter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class GitPullRequestFilter : IGitPullRequestFilter

Syntax (vb)

Public Class GitPullRequestFilter Implements IGitPullRequestFilter

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.CodePipeline;

            var gitPullRequestFilter = new GitPullRequestFilter {
                BranchesExcludes = new [] { "branchesExcludes" },
                BranchesIncludes = new [] { "branchesIncludes" },
                Events = new [] { GitPullRequestEvent.OPEN },
                FilePathsExcludes = new [] { "filePathsExcludes" },
                FilePathsIncludes = new [] { "filePathsIncludes" }
            };

Synopsis

Constructors

GitPullRequestFilter()

Git pull request filter for trigger.

Properties

BranchesExcludes	The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.
BranchesIncludes	The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.
Events	The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.
FilePathsExcludes	The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.
FilePathsIncludes	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.

Constructors

GitPullRequestFilter()

Git pull request filter for trigger.

public GitPullRequestFilter()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.CodePipeline;

            var gitPullRequestFilter = new GitPullRequestFilter {
                BranchesExcludes = new [] { "branchesExcludes" },
                BranchesIncludes = new [] { "branchesIncludes" },
                Events = new [] { GitPullRequestEvent.OPEN },
                FilePathsExcludes = new [] { "filePathsExcludes" },
                FilePathsIncludes = new [] { "filePathsIncludes" }
            };

Properties

BranchesExcludes

The list of patterns of Git branches that, when pull request events occurs, are to be excluded from starting the pipeline.

public string[]? BranchesExcludes { get; set; }

Property Value

string[]

Remarks

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

Maximum length of this array is 8.

Default: - no branches.

BranchesIncludes

The list of patterns of Git branches that, when pull request events occurs, are to be included as criteria that starts the pipeline.

public string[]? BranchesIncludes { get; set; }

Property Value

string[]

Remarks

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

Maximum length of this array is 8.

Default: - no branches.

Events

The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.

public GitPullRequestEvent[]? Events { get; set; }

Property Value

GitPullRequestEvent[]

Remarks

Default: - all events.

FilePathsExcludes

The list of patterns of Git repository file paths that, when pull request events occurs, are to be excluded from starting the pipeline.

public string[]? FilePathsExcludes { get; set; }

Property Value

string[]

Remarks

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

Maximum length of this array is 8.

Default: - no filePaths.

FilePathsIncludes

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.

public string[]? FilePathsIncludes { get; set; }

Property Value

string[]

Remarks

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

Maximum length of this array is 8.

Default: - no filePaths.

Implements

IGitPullRequestFilter