@google-cloud/containeranalysis 6.1.0 → 6.3.0

package/build/src/v1/container_analysis_client.d.ts

@@ -243,8 +243,8 @@ export declare class ContainerAnalysisClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The name of the project to get a vulnerability summary for in the form of
-     *   `projects/[PROJECT_ID]`.
+     *   Required. The name of the project to get a vulnerability summary for in the
+     *   form of `projects/[PROJECT_ID]`.
      * @param {string} request.filter
      *   The filter expression.
      * @param {object} [options]
@@ -258,11 +258,38 @@ export declare class ContainerAnalysisClient {
      */
     getVulnerabilityOccurrencesSummary(request?: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, options?: CallOptions): Promise<[
         protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary,
-        (protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | undefined),
+        protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | undefined,
         {} | undefined
     ]>;
     getVulnerabilityOccurrencesSummary(request: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary, protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
     getVulnerabilityOccurrencesSummary(request: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, callback: Callback<protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary, protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Generates an SBOM for the given resource.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The name of the resource in the form of
+     *   `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.
+     * @param {google.devtools.containeranalysis.v1.ExportSBOMRequest.CloudStorageLocation} [request.cloudStorageLocation]
+     *   Optional. Empty placeholder to denote that this is a Google Cloud Storage
+     *   export request.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.devtools.containeranalysis.v1.ExportSBOMResponse|ExportSBOMResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/container_analysis.export_s_b_o_m.js</caption>
+     * region_tag:containeranalysis_v1_generated_ContainerAnalysis_ExportSBOM_async
+     */
+    exportSBOM(request?: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, options?: CallOptions): Promise<[
+        protos.google.devtools.containeranalysis.v1.IExportSBOMResponse,
+        protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | undefined,
+        {} | undefined
+    ]>;
+    exportSBOM(request: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void;
+    exportSBOM(request: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, callback: Callback<protos.google.devtools.containeranalysis.v1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Return a fully-qualified note resource name string.
      *
@@ -334,13 +361,13 @@ export declare class ContainerAnalysisClient {
      */
     close(): Promise<void>;
     /**
-     * Returns an instance of a @google-cloud/grafeas client, configured to
-     * connect to Google Cloud's Container Analysis API. For documentation
-     * on this client, see:
-     * <a href="https://googleapis.dev/nodejs/grafeas/latest/index.html">https://googleapis.dev/nodejs/grafeas/latest/index.html</a>
-     *
-     * @returns {GrafeasClient} - An instance of a Grafeas client.
-     *
-     */
+    * Returns an instance of a @google-cloud/grafeas client, configured to
+    * connect to Google Cloud's Container Analysis API. For documentation
+    * on this client, see:
+    * <a href="https://googleapis.dev/nodejs/grafeas/latest/index.html">https://googleapis.dev/nodejs/grafeas/latest/index.html</a>
+    *
+    * @returns {GrafeasClient} - An instance of a Grafeas client.
+    *
+    */
     getGrafeasClient(): import("@google-cloud/grafeas/build/src/v1").GrafeasClient;
 }

package/build/src/v1/container_analysis_client.js

@@ -109,26 +109,17 @@ class ContainerAnalysisClient {
     constructor(opts, gaxInstance) {
         // Ensure that options include all the required fields.
         const staticMembers = this.constructor;
-        if (opts?.universe_domain &&
-            opts?.universeDomain &&
-            opts?.universe_domain !== opts?.universeDomain) {
+        if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
             throw new Error('Please set either universe_domain or universeDomain, but not both.');
         }
-        const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
-            ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
-            : undefined;
-        this._universeDomain =
-            opts?.universeDomain ??
-                opts?.universe_domain ??
-                universeDomainEnvVar ??
-                'googleapis.com';
+        const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
+        this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
         this._servicePath = 'containeranalysis.' + this._universeDomain;
         const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
         this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
         const port = opts?.port || staticMembers.port;
         const clientConfig = opts?.clientConfig ?? {};
-        const fallback = opts?.fallback ??
-            (typeof window !== 'undefined' && typeof window?.fetch === 'function');
+        const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
@@ -157,7 +148,10 @@ class ContainerAnalysisClient {
             this.auth.defaultScopes = staticMembers.scopes;
         }
         // Determine the client header string.
-        const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
+        const clientHeader = [
+            `gax/${this._gaxModule.version}`,
+            `gapic/${version}`,
+        ];
         if (typeof process === 'object' && 'versions' in process) {
             clientHeader.push(`gl-node/${process.versions.node}`);
         }
@@ -210,19 +204,13 @@ class ContainerAnalysisClient {
         }
         // Put together the "service stub" for
         // google.devtools.containeranalysis.v1.ContainerAnalysis.
-        this.containerAnalysisStub = this._gaxGrpc.createStub(this._opts.fallback
-            ? this._protos.lookupService('google.devtools.containeranalysis.v1.ContainerAnalysis')
-            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._protos.google.devtools.containeranalysis.v1
-                    .ContainerAnalysis, this._opts, this._providedCustomServicePath);
+        this.containerAnalysisStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.devtools.containeranalysis.v1.ContainerAnalysis') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.devtools.containeranalysis.v1.ContainerAnalysis, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
-        const containerAnalysisStubMethods = [
-            'setIamPolicy',
-            'getIamPolicy',
-            'testIamPermissions',
-            'getVulnerabilityOccurrencesSummary',
-        ];
+        const containerAnalysisStubMethods = ['setIamPolicy', 'getIamPolicy', 'testIamPermissions', 'getVulnerabilityOccurrencesSummary', 'exportSboM'];
         for (const methodName of containerAnalysisStubMethods) {
             const callPromise = this.containerAnalysisStub.then(stub => (...args) => {
                 if (this._terminated) {
@@ -245,8 +233,7 @@ class ContainerAnalysisClient {
      * @returns {string} The DNS address for this service.
      */
     static get servicePath() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'containeranalysis.googleapis.com';
@@ -257,8 +244,7 @@ class ContainerAnalysisClient {
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'containeranalysis.googleapis.com';
@@ -286,7 +272,9 @@ class ContainerAnalysisClient {
      * @returns {string[]} List of default scopes.
      */
     static get scopes() {
-        return ['https://www.googleapis.com/auth/cloud-platform'];
+        return [
+            'https://www.googleapis.com/auth/cloud-platform'
+        ];
     }
     /**
      * Return the project ID used by this class.
@@ -312,13 +300,10 @@ class ContainerAnalysisClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                resource: request.resource ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'resource': request.resource ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('setIamPolicy request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -326,11 +311,16 @@ class ContainerAnalysisClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .setIamPolicy(request, options, wrappedCallback)
+        return this.innerApiCalls.setIamPolicy(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('setIamPolicy response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     getIamPolicy(request, optionsOrCallback, callback) {
@@ -346,13 +336,10 @@ class ContainerAnalysisClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                resource: request.resource ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'resource': request.resource ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('getIamPolicy request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -360,11 +347,16 @@ class ContainerAnalysisClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .getIamPolicy(request, options, wrappedCallback)
+        return this.innerApiCalls.getIamPolicy(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('getIamPolicy response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     testIamPermissions(request, optionsOrCallback, callback) {
@@ -380,13 +372,10 @@ class ContainerAnalysisClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                resource: request.resource ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'resource': request.resource ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('testIamPermissions request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -394,11 +383,16 @@ class ContainerAnalysisClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .testIamPermissions(request, options, wrappedCallback)
+        return this.innerApiCalls.testIamPermissions(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('testIamPermissions response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     getVulnerabilityOccurrencesSummary(request, optionsOrCallback, callback) {
@@ -414,13 +408,10 @@ class ContainerAnalysisClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                parent: request.parent ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('getVulnerabilityOccurrencesSummary request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -428,11 +419,52 @@ class ContainerAnalysisClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .getVulnerabilityOccurrencesSummary(request, options, wrappedCallback)
+        return this.innerApiCalls.getVulnerabilityOccurrencesSummary(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('getVulnerabilityOccurrencesSummary response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    exportSBOM(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'name': request.name ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        this._log.info('exportSBOM request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('exportSBOM response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls.exportSboM(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('exportSBOM response %j', response);
+            return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     // --------------------
@@ -492,8 +524,7 @@ class ContainerAnalysisClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromOccurrenceName(occurrenceName) {
-        return this.pathTemplates.occurrencePathTemplate.match(occurrenceName)
-            .project;
+        return this.pathTemplates.occurrencePathTemplate.match(occurrenceName).project;
     }
     /**
      * Parse the occurrence from Occurrence resource.
@@ -503,8 +534,7 @@ class ContainerAnalysisClient {
      * @returns {string} A string representing the occurrence.
      */
     matchOccurrenceFromOccurrenceName(occurrenceName) {
-        return this.pathTemplates.occurrencePathTemplate.match(occurrenceName)
-            .occurrence;
+        return this.pathTemplates.occurrencePathTemplate.match(occurrenceName).occurrence;
     }
     /**
      * Return a fully-qualified project resource name string.
@@ -544,14 +574,14 @@ class ContainerAnalysisClient {
         return Promise.resolve();
     }
     /**
-     * Returns an instance of a @google-cloud/grafeas client, configured to
-     * connect to Google Cloud's Container Analysis API. For documentation
-     * on this client, see:
-     * <a href="https://googleapis.dev/nodejs/grafeas/latest/index.html">https://googleapis.dev/nodejs/grafeas/latest/index.html</a>
-     *
-     * @returns {GrafeasClient} - An instance of a Grafeas client.
-     *
-     */
+    * Returns an instance of a @google-cloud/grafeas client, configured to
+    * connect to Google Cloud's Container Analysis API. For documentation
+    * on this client, see:
+    * <a href="https://googleapis.dev/nodejs/grafeas/latest/index.html">https://googleapis.dev/nodejs/grafeas/latest/index.html</a>
+    *
+    * @returns {GrafeasClient} - An instance of a Grafeas client.
+    *
+    */
     getGrafeasClient() {
         return new grafeas_1.GrafeasClient(this._opts);
     }

package/build/src/v1/container_analysis_client_config.json

@@ -35,6 +35,10 @@
                 "GetVulnerabilityOccurrencesSummary": {
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default"
+                },
+                "ExportSBOM": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
                 }
             }
         }

package/build/src/v1/container_analysis_proto_list.json

@@ -15,6 +15,7 @@
     "../../protos/grafeas/v1/package.proto",
     "../../protos/grafeas/v1/provenance.proto",
     "../../protos/grafeas/v1/sbom.proto",
+    "../../protos/grafeas/v1/secret.proto",
     "../../protos/grafeas/v1/severity.proto",
     "../../protos/grafeas/v1/slsa_provenance.proto",
     "../../protos/grafeas/v1/slsa_provenance_zero_two.proto",

package/build/src/v1/gapic_metadata.json

@@ -29,6 +29,11 @@
                             "methods": [
                                 "getVulnerabilityOccurrencesSummary"
                             ]
+                        },
+                        "ExportSBOM": {
+                            "methods": [
+                                "exportSBOM"
+                            ]
                         }
                     }
                 },
@@ -54,6 +59,11 @@
                             "methods": [
                                 "getVulnerabilityOccurrencesSummary"
                             ]
+                        },
+                        "ExportSBOM": {
+                            "methods": [
+                                "exportSBOM"
+                            ]
                         }
                     }
                 }

package/build/src/v1/grafeas_proto_list.json

@@ -15,6 +15,7 @@
     "../../protos/grafeas/v1/package.proto",
     "../../protos/grafeas/v1/provenance.proto",
     "../../protos/grafeas/v1/sbom.proto",
+    "../../protos/grafeas/v1/secret.proto",
     "../../protos/grafeas/v1/severity.proto",
     "../../protos/grafeas/v1/slsa_provenance.proto",
     "../../protos/grafeas/v1/slsa_provenance_zero_two.proto",

package/build/src/v1beta1/container_analysis_v1_beta1_client.d.ts

@@ -253,7 +253,7 @@ export declare class ContainerAnalysisV1Beta1Client {
      */
     generatePackagesSummary(request?: protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest, options?: CallOptions): Promise<[
         protos.google.devtools.containeranalysis.v1beta1.IPackagesSummaryResponse,
-        (protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest | undefined),
+        protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest | undefined,
         {} | undefined
     ]>;
     generatePackagesSummary(request: protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IPackagesSummaryResponse, protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest | null | undefined, {} | null | undefined>): void;
@@ -277,7 +277,7 @@ export declare class ContainerAnalysisV1Beta1Client {
      */
     exportSBOM(request?: protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest, options?: CallOptions): Promise<[
         protos.google.devtools.containeranalysis.v1beta1.IExportSBOMResponse,
-        (protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest | undefined),
+        protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest | undefined,
         {} | undefined
     ]>;
     exportSBOM(request: protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void;