« blib/lib/Paws/CodePipeline/WebhookDefinition.pm
↑ Summary
blib/lib/Paws/CodeStar/AssociateTeamMember.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodePipeline::WebhookFilterRule; | ||
| 3 | use Moose; | ||
| 4 | has JsonPath => (is => 'ro', isa => 'Str', request_name => 'jsonPath', traits => ['NameInRequest'], required => 1); | ||
| 5 | has MatchEquals => (is => 'ro', isa => 'Str', request_name => 'matchEquals', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CodePipeline::WebhookFilterRule | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CodePipeline::WebhookFilterRule object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { JsonPath => $value, ..., MatchEquals => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodePipeline::WebhookFilterRule object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->JsonPath | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The event criteria that specify when a webhook notification is sent to | ||
| 38 | your URL. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> JsonPath => Str | ||
| 44 | |||
| 45 | A JsonPath expression that is applied to the body/payload of the | ||
| 46 | webhook. The value selected by the JsonPath expression must match the | ||
| 47 | value specified in the C<MatchEquals> field. Otherwise, the request is | ||
| 48 | ignored. For more information, see Java JsonPath implementation | ||
| 49 | (https://github.com/json-path/JsonPath) in GitHub. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 MatchEquals => Str | ||
| 53 | |||
| 54 | The value selected by the C<JsonPath> expression must match what is | ||
| 55 | supplied in the C<MatchEquals> field. Otherwise, the request is | ||
| 56 | ignored. Properties from the target action configuration can be | ||
| 57 | included as placeholders in this value by surrounding the action | ||
| 58 | configuration key with curly brackets. For example, if the value | ||
| 59 | supplied here is "refs/heads/{Branch}" and the target action has an | ||
| 60 | action configuration property called "Branch" with a value of "master", | ||
| 61 | the C<MatchEquals> value is evaluated as "refs/heads/master". For a | ||
| 62 | list of action configuration properties for built-in action types, see | ||
| 63 | Pipeline Structure Reference Action Requirements | ||
| 64 | (https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html#action-requirements). | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::CodePipeline> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |