@maxim_mazurok/gapi.client.containeranalysis-v1alpha1 0.0.20220928 → 0.0.20221015

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +137 -7
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://containeranalysis.googleapis.com/$discovery/rest?version=v1alpha1
12
- // Revision: 20220928
12
+ // Revision: 20221015
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -156,6 +156,67 @@ declare namespace gapi.client {
156
156
  /** Signature of the related `BuildProvenance`, encoded in a base64 string. */
157
157
  signature?: string;
158
158
  }
159
+ interface BuildStep {
160
+ /**
161
+ * Allow this build step to fail without failing the entire build if and only if the exit code is one of the specified codes. If allow_failure is also specified, this field will take
162
+ * precedence.
163
+ */
164
+ allowExitCodes?: number[];
165
+ /**
166
+ * Allow this build step to fail without failing the entire build. If false, the entire build will fail if this step fails. Otherwise, the build will succeed, but this step will still
167
+ * have a failure status. Error information will be reported in the failure_detail field.
168
+ */
169
+ allowFailure?: boolean;
170
+ /**
171
+ * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that
172
+ * entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
173
+ */
174
+ args?: string[];
175
+ /**
176
+ * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be
177
+ * outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the
178
+ * build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
179
+ */
180
+ dir?: string;
181
+ /** Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. */
182
+ entrypoint?: string;
183
+ /** A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". */
184
+ env?: string[];
185
+ /** Output only. Return code from running the step. */
186
+ exitCode?: number;
187
+ /** Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. */
188
+ id?: string;
189
+ /**
190
+ * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not,
191
+ * the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all
192
+ * of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also
193
+ * have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous
194
+ * build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step.
195
+ */
196
+ name?: string;
197
+ /** Output only. Stores timing information for pulling this build step's builder image only. */
198
+ pullTiming?: TimeSpan;
199
+ /** A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. */
200
+ script?: string;
201
+ /** A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. */
202
+ secretEnv?: string[];
203
+ /** Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. */
204
+ status?: string;
205
+ /** Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. */
206
+ timeout?: string;
207
+ /** Output only. Stores timing information for executing this build step. */
208
+ timing?: TimeSpan;
209
+ /**
210
+ * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their
211
+ * contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration.
212
+ */
213
+ volumes?: Volume[];
214
+ /**
215
+ * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty,
216
+ * this build step will start when all previous build steps in the `Build.Steps` list have completed successfully.
217
+ */
218
+ waitFor?: string[];
219
+ }
159
220
  interface BuildType {
160
221
  /** Version of the builder which produced this Note. */
161
222
  builderVersion?: string;
@@ -245,12 +306,22 @@ declare namespace gapi.client {
245
306
  * images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE.
246
307
  */
247
308
  images?: string[];
309
+ /**
310
+ * A list of Maven artifacts to be uploaded to Artifact Registry upon successful completion of all build steps. Artifacts in the workspace matching specified paths globs will be
311
+ * uploaded to the specified Artifact Registry repository using the builder service account's credentials. If any artifacts fail to be pushed, the build is marked FAILURE.
312
+ */
313
+ mavenArtifacts?: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact[];
248
314
  /**
249
315
  * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the
250
316
  * specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results
251
317
  * field. If any objects fail to be pushed, the build is marked FAILURE.
252
318
  */
253
319
  objects?: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects;
320
+ /**
321
+ * A list of Python packages to be uploaded to Artifact Registry upon successful completion of all build steps. The build service account credentials will be used to perform the
322
+ * upload. If any objects fail to be pushed, the build is marked FAILURE.
323
+ */
324
+ pythonPackages?: ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage[];
254
325
  }
255
326
  interface ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects {
256
327
  /**
@@ -264,6 +335,33 @@ declare namespace gapi.client {
264
335
  /** Output only. Stores timing information for pushing all artifact objects. */
265
336
  timing?: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan;
266
337
  }
338
+ interface ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact {
339
+ /** Maven `artifactId` value used when uploading the artifact to Artifact Registry. */
340
+ artifactId?: string;
341
+ /** Maven `groupId` value used when uploading the artifact to Artifact Registry. */
342
+ groupId?: string;
343
+ /**
344
+ * Path to an artifact in the build's workspace to be uploaded to Artifact Registry. This can be either an absolute path, e.g. /workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a
345
+ * relative path from /workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
346
+ */
347
+ path?: string;
348
+ /**
349
+ * Artifact Registry repository, in the form "https://$REGION-maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified by path will be uploaded to Artifact Registry with
350
+ * this location as a prefix.
351
+ */
352
+ repository?: string;
353
+ /** Maven `version` value used when uploading the artifact to Artifact Registry. */
354
+ version?: string;
355
+ }
356
+ interface ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage {
357
+ /** Path globs used to match files in the build's workspace. For Python/ Twine, this is usually `dist/*`, and sometimes additionally an `.asc` file. */
358
+ paths?: string[];
359
+ /**
360
+ * Artifact Registry repository, in the form "https://$REGION-python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any path pattern will be uploaded to Artifact
361
+ * Registry with this location as a prefix.
362
+ */
363
+ repository?: string;
364
+ }
267
365
  interface ContaineranalysisGoogleDevtoolsCloudbuildV1Build {
268
366
  /** Output only. Describes this build's approval configuration, status, and result. */
269
367
  approval?: ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval;
@@ -338,8 +436,8 @@ declare namespace gapi.client {
338
436
  */
339
437
  timeout?: string;
340
438
  /**
341
- * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all specified images. * FETCHSOURCE:
342
- * time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
439
+ * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images
440
+ * and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included.
343
441
  */
344
442
  timing?: { [P in string]: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan };
345
443
  /** Output only. Non-fatal problems encountered during the execution of the build. */
@@ -533,9 +631,9 @@ declare namespace gapi.client {
533
631
  tagName?: string;
534
632
  }
535
633
  interface ContaineranalysisGoogleDevtoolsCloudbuildV1Results {
536
- /** Path to the artifact manifest. Only populated when artifacts are uploaded. */
634
+ /** Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. */
537
635
  artifactManifest?: string;
538
- /** Time to push all non-container artifacts. */
636
+ /** Time to push all non-container artifacts to Cloud Storage. */
539
637
  artifactTiming?: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan;
540
638
  /** List of build step digests, in the order corresponding to build step indices. */
541
639
  buildStepImages?: string[];
@@ -546,8 +644,12 @@ declare namespace gapi.client {
546
644
  buildStepOutputs?: string[];
547
645
  /** Container images that were built as a part of the build. */
548
646
  images?: ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage[];
549
- /** Number of artifacts uploaded. Only populated when artifacts are uploaded. */
647
+ /** Maven artifacts uploaded to Artifact Registry at the end of the build. */
648
+ mavenArtifacts?: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact[];
649
+ /** Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage. */
550
650
  numArtifacts?: string;
651
+ /** Python artifacts uploaded to Artifact Registry at the end of the build. */
652
+ pythonPackages?: ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage[];
551
653
  }
552
654
  interface ContaineranalysisGoogleDevtoolsCloudbuildV1Secret {
553
655
  /** Cloud KMS key name to use to decrypt these envs. */
@@ -617,6 +719,22 @@ declare namespace gapi.client {
617
719
  /** Start of time span. */
618
720
  startTime?: string;
619
721
  }
722
+ interface ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact {
723
+ /** Hash types and values of the Maven Artifact. */
724
+ fileHashes?: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes;
725
+ /** Output only. Stores timing information for pushing the specified artifact. */
726
+ pushTiming?: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan;
727
+ /** URI of the uploaded artifact. */
728
+ uri?: string;
729
+ }
730
+ interface ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage {
731
+ /** Hash types and values of the Python Artifact. */
732
+ fileHashes?: ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes;
733
+ /** Output only. Stores timing information for pushing the specified artifact. */
734
+ pushTiming?: ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan;
735
+ /** URI of the uploaded artifact. */
736
+ uri?: string;
737
+ }
620
738
  interface ContaineranalysisGoogleDevtoolsCloudbuildV1Volume {
621
739
  /** Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */
622
740
  name?: string;
@@ -1599,7 +1717,7 @@ declare namespace gapi.client {
1599
1717
  fileHashes?: { [P in string]: FileHashes };
1600
1718
  /** If provided, get source from this location in a Cloud Repo. */
1601
1719
  repoSource?: RepoSource;
1602
- /** If provided, get the source from this location in in Google Cloud Storage. */
1720
+ /** If provided, get the source from this location in Google Cloud Storage. */
1603
1721
  storageSource?: StorageSource;
1604
1722
  }
1605
1723
  interface Status {
@@ -1638,6 +1756,12 @@ declare namespace gapi.client {
1638
1756
  /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
1639
1757
  permissions?: string[];
1640
1758
  }
1759
+ interface TimeSpan {
1760
+ /** End of time span. */
1761
+ endTime?: string;
1762
+ /** Start of time span. */
1763
+ startTime?: string;
1764
+ }
1641
1765
  interface UpdateOperationRequest {
1642
1766
  /** The operation to create. */
1643
1767
  operation?: Operation;
@@ -1685,6 +1809,12 @@ declare namespace gapi.client {
1685
1809
  /** The iteration of the package build from the above version. */
1686
1810
  revision?: string;
1687
1811
  }
1812
+ interface Volume {
1813
+ /** Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. */
1814
+ name?: string;
1815
+ /** Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. */
1816
+ path?: string;
1817
+ }
1688
1818
  interface VulnerabilityDetails {
1689
1819
  /** Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity. */
1690
1820
  cvssScore?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.containeranalysis-v1alpha1",
3
- "version": "0.0.20220928",
3
+ "version": "0.0.20221015",
4
4
  "description": "TypeScript typings for Container Analysis API v1alpha1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20220928
6
+ // Revision: 20221015
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */