software.amazon.awscdk.services.codebuild

Class FilterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.FilterGroup

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.332Z")
 @Stability(value=Stable)
public class FilterGroup
extends software.amazon.jsii.JsiiObject

An object that represents a group of filter conditions for a webhook.

Every condition in a given FilterGroup must be true in order for the whole group to be true. You construct instances of it by calling the {@link #inEventOf} static factory method, and then calling various andXyz instance methods to create modified instances of it (this class is immutable).

You pass instances of this class to the webhookFilters property when constructing a source.

Example:

 ISource gitHubSource = Source.gitHub(GitHubSourceProps.builder()
         .owner("awslabs")
         .repo("aws-cdk")
         .webhook(true) // optional, default: true if `webhookFilters` were provided, false otherwise
         .webhookTriggersBatchBuild(true) // optional, default is false
         .webhookFilters(List.of(FilterGroup.inEventOf(EventAction.PUSH).andBranchIs("main").andCommitMessageIs("the commit message")))
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	FilterGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
FilterGroup	andActorAccountIs(String pattern) Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must match the given pattern.
FilterGroup	andActorAccountIsNot(String pattern) Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must not match the given pattern.
FilterGroup	andBaseBranchIs(String branchName) Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given base branch.
FilterGroup	andBaseBranchIsNot(String branchName) Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given base branch.
FilterGroup	andBaseRefIs(String pattern) Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given Git reference.
FilterGroup	andBaseRefIsNot(String pattern) Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given Git reference.
FilterGroup	andBranchIs(String branchName) Create a new FilterGroup with an added condition: the event must affect the given branch.
FilterGroup	andBranchIsNot(String branchName) Create a new FilterGroup with an added condition: the event must not affect the given branch.
FilterGroup	andCommitMessageIs(String commitMessage) Create a new FilterGroup with an added condition: the event must affect a head commit with the given message.
FilterGroup	andCommitMessageIsNot(String commitMessage) Create a new FilterGroup with an added condition: the event must not affect a head commit with the given message.
FilterGroup	andFilePathIs(String pattern) Create a new FilterGroup with an added condition: the push that is the source of the event must affect a file that matches the given pattern.
FilterGroup	andFilePathIsNot(String pattern) Create a new FilterGroup with an added condition: the push that is the source of the event must not affect a file that matches the given pattern.
FilterGroup	andHeadRefIs(String pattern) Create a new FilterGroup with an added condition: the event must affect a Git reference (ie., a branch or a tag) that matches the given pattern.
FilterGroup	andHeadRefIsNot(String pattern) Create a new FilterGroup with an added condition: the event must not affect a Git reference (ie., a branch or a tag) that matches the given pattern.
FilterGroup	andTagIs(String tagName) Create a new FilterGroup with an added condition: the event must affect the given tag.
FilterGroup	andTagIsNot(String tagName) Create a new FilterGroup with an added condition: the event must not affect the given tag.
static FilterGroup	inEventOf(EventAction... actions) Creates a new event FilterGroup that triggers on any of the provided actions.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

FilterGroup

protected FilterGroup(software.amazon.jsii.JsiiObjectRef objRef)

FilterGroup

protected FilterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

inEventOf

@Stability(value=Stable)
 @NotNull
public static FilterGroup inEventOf(@NotNull
                                                                       EventAction... actions)

Creates a new event FilterGroup that triggers on any of the provided actions.

Parameters:

actions - the actions to trigger the webhook on. This parameter is required.

andActorAccountIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andActorAccountIs(@NotNull
                                                                        String pattern)

Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must match the given pattern.

Parameters:

pattern - a regular expression. This parameter is required.

andActorAccountIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andActorAccountIsNot(@NotNull
                                                                           String pattern)

Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must not match the given pattern.

Parameters:

pattern - a regular expression. This parameter is required.

andBaseBranchIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andBaseBranchIs(@NotNull
                                                                      String branchName)

Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given base branch.

Note that you cannot use this method if this Group contains the PUSH event action.

Parameters:

branchName - the name of the branch (can be a regular expression). This parameter is required.

andBaseBranchIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andBaseBranchIsNot(@NotNull
                                                                         String branchName)

Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given base branch.

Note that you cannot use this method if this Group contains the PUSH event action.

Parameters:

branchName - the name of the branch (can be a regular expression). This parameter is required.

andBaseRefIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andBaseRefIs(@NotNull
                                                                   String pattern)

Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given Git reference.

Note that you cannot use this method if this Group contains the PUSH event action.

Parameters:

pattern - a regular expression. This parameter is required.

andBaseRefIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andBaseRefIsNot(@NotNull
                                                                      String pattern)

Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given Git reference.

Note that you cannot use this method if this Group contains the PUSH event action.

Parameters:

pattern - a regular expression. This parameter is required.

andBranchIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andBranchIs(@NotNull
                                                                  String branchName)

Create a new FilterGroup with an added condition: the event must affect the given branch.

Parameters:

branchName - the name of the branch (can be a regular expression). This parameter is required.

andBranchIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andBranchIsNot(@NotNull
                                                                     String branchName)

Create a new FilterGroup with an added condition: the event must not affect the given branch.

Parameters:

branchName - the name of the branch (can be a regular expression). This parameter is required.

andCommitMessageIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andCommitMessageIs(@NotNull
                                                                         String commitMessage)

Create a new FilterGroup with an added condition: the event must affect a head commit with the given message.

Parameters:

commitMessage - the commit message (can be a regular expression). This parameter is required.

andCommitMessageIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andCommitMessageIsNot(@NotNull
                                                                            String commitMessage)

Create a new FilterGroup with an added condition: the event must not affect a head commit with the given message.

Parameters:

commitMessage - the commit message (can be a regular expression). This parameter is required.

andFilePathIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andFilePathIs(@NotNull
                                                                    String pattern)

Create a new FilterGroup with an added condition: the push that is the source of the event must affect a file that matches the given pattern.

Note that you can only use this method if this Group contains only the PUSH event action, and only for GitHub, Bitbucket and GitHubEnterprise sources.

Parameters:

pattern - a regular expression. This parameter is required.

andFilePathIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andFilePathIsNot(@NotNull
                                                                       String pattern)

Create a new FilterGroup with an added condition: the push that is the source of the event must not affect a file that matches the given pattern.

Note that you can only use this method if this Group contains only the PUSH event action, and only for GitHub, Bitbucket and GitHubEnterprise sources.

Parameters:

pattern - a regular expression. This parameter is required.

andHeadRefIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andHeadRefIs(@NotNull
                                                                   String pattern)

Create a new FilterGroup with an added condition: the event must affect a Git reference (ie., a branch or a tag) that matches the given pattern.

Parameters:

pattern - a regular expression. This parameter is required.

andHeadRefIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andHeadRefIsNot(@NotNull
                                                                      String pattern)

Create a new FilterGroup with an added condition: the event must not affect a Git reference (ie., a branch or a tag) that matches the given pattern.

Parameters:

pattern - a regular expression. This parameter is required.

andTagIs

@Stability(value=Stable)
 @NotNull
public FilterGroup andTagIs(@NotNull
                                                               String tagName)

Create a new FilterGroup with an added condition: the event must affect the given tag.

Parameters:

tagName - the name of the tag (can be a regular expression). This parameter is required.

andTagIsNot

@Stability(value=Stable)
 @NotNull
public FilterGroup andTagIsNot(@NotNull
                                                                  String tagName)

Create a new FilterGroup with an added condition: the event must not affect the given tag.

Parameters:

tagName - the name of the tag (can be a regular expression). This parameter is required.