NAME

Paws::CodeBuild::WebhookFilter

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CodeBuild::WebhookFilter object:

  $service_obj->Method(Att1 => { ExcludeMatchedPattern => $value, ..., Type => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::WebhookFilter object:

  $result = $service_obj->Method(...);
  $result->Att1->ExcludeMatchedPattern

DESCRIPTION

A filter used to determine which webhooks trigger a build.

ATTRIBUTES

ExcludeMatchedPattern => Bool

Used to indicate that the "pattern" determines which webhook events do not trigger a build. If true, then a webhook event that does not match the "pattern" triggers a build. If false, then a webhook event that matches the "pattern" triggers a build.

REQUIRED Pattern => Str

For a "WebHookFilter" that uses "EVENT" type, a comma-separated string that specifies one or more events. For example, the webhook filter "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED" allows all push, pull request created, and pull request updated events to trigger a build.

For a "WebHookFilter" that uses any of the other filter types, a regular expression pattern. For example, a "WebHookFilter" that uses "HEAD_REF" for its "type" and the pattern "^refs/heads/" triggers a build when the head reference is a branch with a reference name "refs/heads/branch-name".

REQUIRED Type => Str

The type of webhook filter. There are six webhook filter types: "EVENT", "ACTOR_ACCOUNT_ID", "HEAD_REF", "BASE_REF", "FILE_PATH", and "COMMIT_MESSAGE".

EVENT: A webhook event triggers a build when the provided "pattern" matches one of five event types: "PUSH", "PULL_REQUEST_CREATED", "PULL_REQUEST_UPDATED", "PULL_REQUEST_REOPENED", and "PULL_REQUEST_MERGED". The "EVENT" patterns are specified as a comma-separated string. For example, "PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED" filters all push, pull request created, and pull request updated events.
The "PULL_REQUEST_REOPENED" works with GitHub and GitHub Enterprise only.
ACTOR_ACCOUNT_ID: A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression "pattern".
HEAD_REF: A webhook event triggers a build when the head reference matches the regular expression "pattern". For example, "refs/heads/branch-name" and "refs/tags/tag-name".
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
BASE_REF: A webhook event triggers a build when the base reference matches the regular expression "pattern". For example, "refs/heads/branch-name".
Works with pull request events only.
FILE_PATH: A webhook triggers a build when the path of a changed file matches the regular expression "pattern".
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
COMMIT_MESSAGE: A webhook triggers a build when the head commit message matches the regular expression "pattern".
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>