| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::WebhookFilter; | ||
| 3 | use Moose; | ||
| 4 | has ExcludeMatchedPattern => (is => 'ro', isa => 'Bool', request_name => 'excludeMatchedPattern', traits => ['NameInRequest']); | ||
| 5 | has Pattern => (is => 'ro', isa => 'Str', request_name => 'pattern', traits => ['NameInRequest'], required => 1); | ||
| 6 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::CodeBuild::WebhookFilter | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::CodeBuild::WebhookFilter object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ExcludeMatchedPattern => $value, ..., Type => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::WebhookFilter object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ExcludeMatchedPattern | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A filter used to determine which webhooks trigger a build. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 ExcludeMatchedPattern => Bool | ||
| 44 | |||
| 45 | Used to indicate that the C<pattern> determines which webhook events do | ||
| 46 | not trigger a build. If true, then a webhook event that does not match | ||
| 47 | the C<pattern> triggers a build. If false, then a webhook event that | ||
| 48 | matches the C<pattern> triggers a build. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Pattern => Str | ||
| 52 | |||
| 53 | For a C<WebHookFilter> that uses C<EVENT> type, a comma-separated | ||
| 54 | string that specifies one or more events. For example, the webhook | ||
| 55 | filter C<PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED> allows all | ||
| 56 | push, pull request created, and pull request updated events to trigger | ||
| 57 | a build. | ||
| 58 | |||
| 59 | For a C<WebHookFilter> that uses any of the other filter types, a | ||
| 60 | regular expression pattern. For example, a C<WebHookFilter> that uses | ||
| 61 | C<HEAD_REF> for its C<type> and the pattern C<^refs/heads/> triggers a | ||
| 62 | build when the head reference is a branch with a reference name | ||
| 63 | C<refs/heads/branch-name>. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Type => Str | ||
| 67 | |||
| 68 | The type of webhook filter. There are six webhook filter types: | ||
| 69 | C<EVENT>, C<ACTOR_ACCOUNT_ID>, C<HEAD_REF>, C<BASE_REF>, C<FILE_PATH>, | ||
| 70 | and C<COMMIT_MESSAGE>. | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item EVENT | ||
| 75 | |||
| 76 | A webhook event triggers a build when the provided C<pattern> matches | ||
| 77 | one of five event types: C<PUSH>, C<PULL_REQUEST_CREATED>, | ||
| 78 | C<PULL_REQUEST_UPDATED>, C<PULL_REQUEST_REOPENED>, and | ||
| 79 | C<PULL_REQUEST_MERGED>. The C<EVENT> patterns are specified as a | ||
| 80 | comma-separated string. For example, C<PUSH, PULL_REQUEST_CREATED, | ||
| 81 | PULL_REQUEST_UPDATED> filters all push, pull request created, and pull | ||
| 82 | request updated events. | ||
| 83 | |||
| 84 | The C<PULL_REQUEST_REOPENED> works with GitHub and GitHub Enterprise | ||
| 85 | only. | ||
| 86 | |||
| 87 | =item ACTOR_ACCOUNT_ID | ||
| 88 | |||
| 89 | A webhook event triggers a build when a GitHub, GitHub Enterprise, or | ||
| 90 | Bitbucket account ID matches the regular expression C<pattern>. | ||
| 91 | |||
| 92 | =item HEAD_REF | ||
| 93 | |||
| 94 | A webhook event triggers a build when the head reference matches the | ||
| 95 | regular expression C<pattern>. For example, C<refs/heads/branch-name> | ||
| 96 | and C<refs/tags/tag-name>. | ||
| 97 | |||
| 98 | Works with GitHub and GitHub Enterprise push, GitHub and GitHub | ||
| 99 | Enterprise pull request, Bitbucket push, and Bitbucket pull request | ||
| 100 | events. | ||
| 101 | |||
| 102 | =item BASE_REF | ||
| 103 | |||
| 104 | A webhook event triggers a build when the base reference matches the | ||
| 105 | regular expression C<pattern>. For example, C<refs/heads/branch-name>. | ||
| 106 | |||
| 107 | Works with pull request events only. | ||
| 108 | |||
| 109 | =item FILE_PATH | ||
| 110 | |||
| 111 | A webhook triggers a build when the path of a changed file matches the | ||
| 112 | regular expression C<pattern>. | ||
| 113 | |||
| 114 | Works with GitHub and Bitbucket events push and pull requests events. | ||
| 115 | Also works with GitHub Enterprise push events, but does not work with | ||
| 116 | GitHub Enterprise pull request events. | ||
| 117 | |||
| 118 | =item COMMIT_MESSAGE | ||
| 119 | |||
| 120 | A webhook triggers a build when the head commit message matches the | ||
| 121 | regular expression C<pattern>. | ||
| 122 | |||
| 123 | Works with GitHub and Bitbucket events push and pull requests events. | ||
| 124 | Also works with GitHub Enterprise push events, but does not work with | ||
| 125 | GitHub Enterprise pull request events. | ||
| 126 | |||
| 127 | =back | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head1 SEE ALSO | ||
| 133 | |||
| 134 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 135 | |||
| 136 | =head1 BUGS and CONTRIBUTIONS | ||
| 137 | |||
| 138 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 139 | |||
| 140 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 141 | |||
| 142 | =cut | ||
| 143 |