blib/lib/Paws/CodePipeline/WebhookDefinition.pm untested

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::CodePipeline::WebhookDefinition;
3 use Moose;
4 has Authentication => (is => 'ro', isa => 'Str', request_name => 'authentication', traits => ['NameInRequest'], required => 1);
5 has AuthenticationConfiguration => (is => 'ro', isa => 'Paws::CodePipeline::WebhookAuthConfiguration', request_name => 'authenticationConfiguration', traits => ['NameInRequest'], required => 1);
6 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::CodePipeline::WebhookFilterRule]', request_name => 'filters', traits => ['NameInRequest'], required => 1);
7 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1);
8 has TargetAction => (is => 'ro', isa => 'Str', request_name => 'targetAction', traits => ['NameInRequest'], required => 1);
9 has TargetPipeline => (is => 'ro', isa => 'Str', request_name => 'targetPipeline', traits => ['NameInRequest'], required => 1);
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::CodePipeline::WebhookDefinition
18  
19 =head1 USAGE
20  
21 This class represents one of two things:
22  
23 =head3 Arguments in a call to a service
24  
25 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26 Each attribute should be used as a named argument in the calls that expect this type of object.
27  
28 As an example, if Att1 is expected to be a Paws::CodePipeline::WebhookDefinition object:
29  
30 $service_obj->Method(Att1 => { Authentication => $value, ..., TargetPipeline => $value });
31  
32 =head3 Results returned from an API call
33  
34 Use accessors for each attribute. If Att1 is expected to be an Paws::CodePipeline::WebhookDefinition object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->Authentication
38  
39 =head1 DESCRIPTION
40  
41 Represents information about a webhook and its definition.
42  
43 =head1 ATTRIBUTES
44  
45  
46 =head2 B<REQUIRED> Authentication => Str
47  
48 Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
49  
50 =over
51  
52 =item *
53  
54 For information about the authentication scheme implemented by
55 GITHUB_HMAC, see Securing your webhooks
56 (https://developer.github.com/webhooks/securing/) on the GitHub
57 Developer website.
58  
59 =item *
60  
61 IP rejects webhooks trigger requests unless they originate from an IP
62 address in the IP range whitelisted in the authentication
63 configuration.
64  
65 =item *
66  
67 UNAUTHENTICATED accepts all webhook trigger requests regardless of
68 origin.
69  
70 =back
71  
72  
73  
74 =head2 B<REQUIRED> AuthenticationConfiguration => L<Paws::CodePipeline::WebhookAuthConfiguration>
75  
76 Properties that configure the authentication applied to incoming
77 webhook trigger requests. The required properties depend on the
78 authentication type. For GITHUB_HMAC, only the C<SecretToken >property
79 must be set. For IP, only the C<AllowedIPRange >property must be set to
80 a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
81  
82  
83 =head2 B<REQUIRED> Filters => ArrayRef[L<Paws::CodePipeline::WebhookFilterRule>]
84  
85 A list of rules applied to the body/payload sent in the POST request to
86 a webhook URL. All defined rules must pass for the request to be
87 accepted and the pipeline started.
88  
89  
90 =head2 B<REQUIRED> Name => Str
91  
92 The name of the webhook.
93  
94  
95 =head2 B<REQUIRED> TargetAction => Str
96  
97 The name of the action in a pipeline you want to connect to the
98 webhook. The action must be from the source (first) stage of the
99 pipeline.
100  
101  
102 =head2 B<REQUIRED> TargetPipeline => Str
103  
104 The name of the pipeline you want to connect to the webhook.
105  
106  
107  
108 =head1 SEE ALSO
109  
110 This class forms part of L<Paws>, describing an object used in L<Paws::CodePipeline>
111  
112 =head1 BUGS and CONTRIBUTIONS
113  
114 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
115  
116 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
117  
118 =cut
119