File Coverage

blib/lib/Paws/CodeBuild/ProjectArtifacts.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CodeBuild::ProjectArtifacts;
2 1     1   445 use Moose;
  1         3  
  1         6  
3             has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']);
4             has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
5             has NamespaceType => (is => 'ro', isa => 'Str', request_name => 'namespaceType', traits => ['NameInRequest']);
6             has Packaging => (is => 'ro', isa => 'Str', request_name => 'packaging', traits => ['NameInRequest']);
7             has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']);
8             has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::CodeBuild::ProjectArtifacts
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectArtifacts object:
27              
28             $service_obj->Method(Att1 => { Location => $value, ..., Type => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectArtifacts object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->Location
36              
37             =head1 DESCRIPTION
38              
39             Information about the build output artifacts for the build project.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Location => Str
45              
46             Information about the build output artifact location, as follows:
47              
48             =over
49              
50             =item *
51              
52             If C<type> is set to C<CODEPIPELINE>, then AWS CodePipeline will ignore
53             this value if specified. This is because AWS CodePipeline manages its
54             build output locations instead of AWS CodeBuild.
55              
56             =item *
57              
58             If C<type> is set to C<NO_ARTIFACTS>, then this value will be ignored
59             if specified, because no build output will be produced.
60              
61             =item *
62              
63             If C<type> is set to C<S3>, this is the name of the output bucket.
64              
65             =back
66              
67              
68              
69             =head2 Name => Str
70              
71             Along with C<path> and C<namespaceType>, the pattern that AWS CodeBuild
72             will use to name and store the output artifact, as follows:
73              
74             =over
75              
76             =item *
77              
78             If C<type> is set to C<CODEPIPELINE>, then AWS CodePipeline will ignore
79             this value if specified. This is because AWS CodePipeline manages its
80             build output names instead of AWS CodeBuild.
81              
82             =item *
83              
84             If C<type> is set to C<NO_ARTIFACTS>, then this value will be ignored
85             if specified, because no build output will be produced.
86              
87             =item *
88              
89             If C<type> is set to C<S3>, this is the name of the output artifact
90             object.
91              
92             =back
93              
94             For example, if C<path> is set to C<MyArtifacts>, C<namespaceType> is
95             set to C<BUILD_ID>, and C<name> is set to C<MyArtifact.zip>, then the
96             output artifact would be stored in
97             C<MyArtifacts/I<build-ID>/MyArtifact.zip>.
98              
99              
100             =head2 NamespaceType => Str
101              
102             Along with C<path> and C<name>, the pattern that AWS CodeBuild will use
103             to determine the name and location to store the output artifact, as
104             follows:
105              
106             =over
107              
108             =item *
109              
110             If C<type> is set to C<CODEPIPELINE>, then AWS CodePipeline will ignore
111             this value if specified. This is because AWS CodePipeline manages its
112             build output names instead of AWS CodeBuild.
113              
114             =item *
115              
116             If C<type> is set to C<NO_ARTIFACTS>, then this value will be ignored
117             if specified, because no build output will be produced.
118              
119             =item *
120              
121             If C<type> is set to C<S3>, then valid values include:
122              
123             =over
124              
125             =item *
126              
127             C<BUILD_ID>: Include the build ID in the location of the build output
128             artifact.
129              
130             =item *
131              
132             C<NONE>: Do not include the build ID. This is the default if
133             C<namespaceType> is not specified.
134              
135             =back
136              
137             =back
138              
139             For example, if C<path> is set to C<MyArtifacts>, C<namespaceType> is
140             set to C<BUILD_ID>, and C<name> is set to C<MyArtifact.zip>, then the
141             output artifact would be stored in
142             C<MyArtifacts/I<build-ID>/MyArtifact.zip>.
143              
144              
145             =head2 Packaging => Str
146              
147             The type of build output artifact to create, as follows:
148              
149             =over
150              
151             =item *
152              
153             If C<type> is set to C<CODEPIPELINE>, then AWS CodePipeline will ignore
154             this value if specified. This is because AWS CodePipeline manages its
155             build output artifacts instead of AWS CodeBuild.
156              
157             =item *
158              
159             If C<type> is set to C<NO_ARTIFACTS>, then this value will be ignored
160             if specified, because no build output will be produced.
161              
162             =item *
163              
164             If C<type> is set to C<S3>, valid values include:
165              
166             =over
167              
168             =item *
169              
170             C<NONE>: AWS CodeBuild will create in the output bucket a folder
171             containing the build output. This is the default if C<packaging> is not
172             specified.
173              
174             =item *
175              
176             C<ZIP>: AWS CodeBuild will create in the output bucket a ZIP file
177             containing the build output.
178              
179             =back
180              
181             =back
182              
183              
184              
185             =head2 Path => Str
186              
187             Along with C<namespaceType> and C<name>, the pattern that AWS CodeBuild
188             will use to name and store the output artifact, as follows:
189              
190             =over
191              
192             =item *
193              
194             If C<type> is set to C<CODEPIPELINE>, then AWS CodePipeline will ignore
195             this value if specified. This is because AWS CodePipeline manages its
196             build output names instead of AWS CodeBuild.
197              
198             =item *
199              
200             If C<type> is set to C<NO_ARTIFACTS>, then this value will be ignored
201             if specified, because no build output will be produced.
202              
203             =item *
204              
205             If C<type> is set to C<S3>, this is the path to the output artifact. If
206             C<path> is not specified, then C<path> will not be used.
207              
208             =back
209              
210             For example, if C<path> is set to C<MyArtifacts>, C<namespaceType> is
211             set to C<NONE>, and C<name> is set to C<MyArtifact.zip>, then the
212             output artifact would be stored in the output bucket at
213             C<MyArtifacts/MyArtifact.zip>.
214              
215              
216             =head2 B<REQUIRED> Type => Str
217              
218             The type of build output artifact. Valid values include:
219              
220             =over
221              
222             =item *
223              
224             C<CODEPIPELINE>: The build project will have build output generated
225             through AWS CodePipeline.
226              
227             =item *
228              
229             C<NO_ARTIFACTS>: The build project will not produce any build output.
230              
231             =item *
232              
233             C<S3>: The build project will store build output in Amazon Simple
234             Storage Service (Amazon S3).
235              
236             =back
237              
238              
239              
240              
241             =head1 SEE ALSO
242              
243             This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild>
244              
245             =head1 BUGS and CONTRIBUTIONS
246              
247             The source code is located here: https://github.com/pplu/aws-sdk-perl
248              
249             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
250              
251             =cut
252