@@ -11,32 +11,44 @@ final class Build
11
11
{
12
12
/**
13
13
* The unique ID for the build.
14
+ *
15
+ * @var string|null
14
16
*/
15
17
private $ id ;
16
18
17
19
/**
18
20
* The Amazon Resource Name (ARN) of the build.
21
+ *
22
+ * @var string|null
19
23
*/
20
24
private $ arn ;
21
25
22
26
/**
23
27
* The number of the build. For each project, the `buildNumber` of its first build is `1`. The `buildNumber` of each
24
28
* subsequent build is incremented by `1`. If a build is deleted, the `buildNumber` of other builds does not change.
29
+ *
30
+ * @var int|null
25
31
*/
26
32
private $ buildNumber ;
27
33
28
34
/**
29
35
* When the build process started, expressed in Unix time format.
36
+ *
37
+ * @var \DateTimeImmutable|null
30
38
*/
31
39
private $ startTime ;
32
40
33
41
/**
34
42
* When the build process ended, expressed in Unix time format.
43
+ *
44
+ * @var \DateTimeImmutable|null
35
45
*/
36
46
private $ endTime ;
37
47
38
48
/**
39
49
* The current build phase.
50
+ *
51
+ * @var string|null
40
52
*/
41
53
private $ currentPhase ;
42
54
@@ -49,6 +61,8 @@ final class Build
49
61
* - `STOPPED`: The build stopped.
50
62
* - `SUCCEEDED`: The build succeeded.
51
63
* - `TIMED_OUT`: The build timed out.
64
+ *
65
+ * @var StatusType::*|null
52
66
*/
53
67
private $ buildStatus ;
54
68
@@ -59,6 +73,8 @@ final class Build
59
73
* For more information, see Source Version Sample with CodeBuild [^1] in the *CodeBuild User Guide*.
60
74
*
61
75
* [^1]: https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html
76
+ *
77
+ * @var string|null
62
78
*/
63
79
private $ sourceVersion ;
64
80
@@ -68,27 +84,37 @@ final class Build
68
84
* - For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
69
85
* - For CodePipeline, the source revision provided by CodePipeline.
70
86
* - For Amazon S3, this does not apply.
87
+ *
88
+ * @var string|null
71
89
*/
72
90
private $ resolvedSourceVersion ;
73
91
74
92
/**
75
93
* The name of the CodeBuild project.
94
+ *
95
+ * @var string|null
76
96
*/
77
97
private $ projectName ;
78
98
79
99
/**
80
100
* Information about all previous build phases that are complete and information about any current build phase that is
81
101
* not yet complete.
102
+ *
103
+ * @var BuildPhase[]|null
82
104
*/
83
105
private $ phases ;
84
106
85
107
/**
86
108
* Information about the source code to be built.
109
+ *
110
+ * @var ProjectSource|null
87
111
*/
88
112
private $ source ;
89
113
90
114
/**
91
115
* An array of `ProjectSource` objects.
116
+ *
117
+ * @var ProjectSource[]|null
92
118
*/
93
119
private $ secondarySources ;
94
120
@@ -104,51 +130,71 @@ final class Build
104
130
* to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
105
131
* branch's HEAD commit ID is used.
106
132
* - For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
133
+ *
134
+ * @var ProjectSourceVersion[]|null
107
135
*/
108
136
private $ secondarySourceVersions ;
109
137
110
138
/**
111
139
* Information about the output artifacts for the build.
140
+ *
141
+ * @var BuildArtifacts|null
112
142
*/
113
143
private $ artifacts ;
114
144
115
145
/**
116
146
* An array of `ProjectArtifacts` objects.
147
+ *
148
+ * @var BuildArtifacts[]|null
117
149
*/
118
150
private $ secondaryArtifacts ;
119
151
120
152
/**
121
153
* Information about the cache for the build.
154
+ *
155
+ * @var ProjectCache|null
122
156
*/
123
157
private $ cache ;
124
158
125
159
/**
126
160
* Information about the build environment for this build.
161
+ *
162
+ * @var ProjectEnvironment|null
127
163
*/
128
164
private $ environment ;
129
165
130
166
/**
131
167
* The name of a service role used for this build.
168
+ *
169
+ * @var string|null
132
170
*/
133
171
private $ serviceRole ;
134
172
135
173
/**
136
174
* Information about the build's logs in CloudWatch Logs.
175
+ *
176
+ * @var LogsLocation|null
137
177
*/
138
178
private $ logs ;
139
179
140
180
/**
141
181
* How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
182
+ *
183
+ * @var int|null
142
184
*/
143
185
private $ timeoutInMinutes ;
144
186
145
187
/**
146
188
* The number of minutes a build is allowed to be queued before it times out.
189
+ *
190
+ * @var int|null
147
191
*/
148
192
private $ queuedTimeoutInMinutes ;
149
193
150
194
/**
151
195
* Whether the build is complete. True if complete; otherwise, false.
196
+ *
197
+ * @var bool|null
152
198
*/
153
199
private $ buildComplete ;
154
200
@@ -158,18 +204,24 @@ final class Build
158
204
* - If CodePipeline started the build, the pipeline's name (for example, `codepipeline/my-demo-pipeline`).
159
205
* - If an IAM user started the build, the user's name (for example, `MyUserName`).
160
206
* - If the Jenkins plugin for CodeBuild started the build, the string `CodeBuild-Jenkins-Plugin`.
207
+ *
208
+ * @var string|null
161
209
*/
162
210
private $ initiator ;
163
211
164
212
/**
165
213
* If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID
166
214
* and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You
167
215
* must provide at least one security group and one subnet ID.
216
+ *
217
+ * @var VpcConfig|null
168
218
*/
169
219
private $ vpcConfig ;
170
220
171
221
/**
172
222
* Describes a network interface.
223
+ *
224
+ * @var NetworkInterface|null
173
225
*/
174
226
private $ networkInterface ;
175
227
@@ -181,6 +233,8 @@ final class Build
181
233
*
182
234
* You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format
183
235
* `alias/<alias-name>`).
236
+ *
237
+ * @var string|null
184
238
*/
185
239
private $ encryptionKey ;
186
240
@@ -192,28 +246,38 @@ final class Build
192
246
* the *CodePipeline User Guide*.
193
247
*
194
248
* [^1]: https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html
249
+ *
250
+ * @var ExportedEnvironmentVariable[]|null
195
251
*/
196
252
private $ exportedEnvironmentVariables ;
197
253
198
254
/**
199
255
* An array of the ARNs associated with this build's reports.
256
+ *
257
+ * @var string[]|null
200
258
*/
201
259
private $ reportArns ;
202
260
203
261
/**
204
262
* An array of `ProjectFileSystemLocation` objects for a CodeBuild build project. A `ProjectFileSystemLocation` object
205
263
* specifies the `identifier`, `location`, `mountOptions`, `mountPoint`, and `type` of a file system created using
206
264
* Amazon Elastic File System.
265
+ *
266
+ * @var ProjectFileSystemLocation[]|null
207
267
*/
208
268
private $ fileSystemLocations ;
209
269
210
270
/**
211
271
* Contains information about the debug session for this build.
272
+ *
273
+ * @var DebugSession|null
212
274
*/
213
275
private $ debugSession ;
214
276
215
277
/**
216
278
* The ARN of the batch build that this build is a member of, if applicable.
279
+ *
280
+ * @var string|null
217
281
*/
218
282
private $ buildBatchArn ;
219
283
0 commit comments