@google-cloud/containeranalysis 6.1.0 → 6.3.0

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.
@@ -106,28 +106,18 @@ class ContainerAnalysisV1Beta1Client {
106
106
  */
107
107
  constructor(opts, gaxInstance) {
108
108
  // Ensure that options include all the required fields.
109
- const staticMembers = this
110
- .constructor;
111
- if (opts?.universe_domain &&
112
- opts?.universeDomain &&
113
- opts?.universe_domain !== opts?.universeDomain) {
109
+ const staticMembers = this.constructor;
110
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
114
111
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
115
112
  }
116
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
117
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
118
- : undefined;
119
- this._universeDomain =
120
- opts?.universeDomain ??
121
- opts?.universe_domain ??
122
- universeDomainEnvVar ??
123
- 'googleapis.com';
113
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
114
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
124
115
  this._servicePath = 'containeranalysis.' + this._universeDomain;
125
116
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
126
117
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
127
118
  const port = opts?.port || staticMembers.port;
128
119
  const clientConfig = opts?.clientConfig ?? {};
129
- const fallback = opts?.fallback ??
130
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
120
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
131
121
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
132
122
  // Request numeric enum values if REST transport is used.
133
123
  opts.numericEnums = true;
@@ -156,7 +146,10 @@ class ContainerAnalysisV1Beta1Client {
156
146
  this.auth.defaultScopes = staticMembers.scopes;
157
147
  }
158
148
  // Determine the client header string.
159
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
149
+ const clientHeader = [
150
+ `gax/${this._gaxModule.version}`,
151
+ `gapic/${version}`,
152
+ ];
160
153
  if (typeof process === 'object' && 'versions' in process) {
161
154
  clientHeader.push(`gl-node/${process.versions.node}`);
162
155
  }
@@ -201,20 +194,13 @@ class ContainerAnalysisV1Beta1Client {
201
194
  }
202
195
  // Put together the "service stub" for
203
196
  // google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1.
204
- this.containerAnalysisV1Beta1Stub = this._gaxGrpc.createStub(this._opts.fallback
205
- ? this._protos.lookupService('google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1')
206
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
207
- this._protos.google.devtools.containeranalysis.v1beta1
208
- .ContainerAnalysisV1Beta1, this._opts, this._providedCustomServicePath);
197
+ this.containerAnalysisV1Beta1Stub = this._gaxGrpc.createStub(this._opts.fallback ?
198
+ this._protos.lookupService('google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1') :
199
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
200
+ this._protos.google.devtools.containeranalysis.v1beta1.ContainerAnalysisV1Beta1, this._opts, this._providedCustomServicePath);
209
201
  // Iterate over each of the methods that the service provides
210
202
  // and create an API call method for each.
211
- const containerAnalysisV1Beta1StubMethods = [
212
- 'setIamPolicy',
213
- 'getIamPolicy',
214
- 'testIamPermissions',
215
- 'generatePackagesSummary',
216
- 'exportSboM',
217
- ];
203
+ const containerAnalysisV1Beta1StubMethods = ['setIamPolicy', 'getIamPolicy', 'testIamPermissions', 'generatePackagesSummary', 'exportSboM'];
218
204
  for (const methodName of containerAnalysisV1Beta1StubMethods) {
219
205
  const callPromise = this.containerAnalysisV1Beta1Stub.then(stub => (...args) => {
220
206
  if (this._terminated) {
@@ -237,8 +223,7 @@ class ContainerAnalysisV1Beta1Client {
237
223
  * @returns {string} The DNS address for this service.
238
224
  */
239
225
  static get servicePath() {
240
- if (typeof process === 'object' &&
241
- typeof process.emitWarning === 'function') {
226
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
242
227
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
243
228
  }
244
229
  return 'containeranalysis.googleapis.com';
@@ -249,8 +234,7 @@ class ContainerAnalysisV1Beta1Client {
249
234
  * @returns {string} The DNS address for this service.
250
235
  */
251
236
  static get apiEndpoint() {
252
- if (typeof process === 'object' &&
253
- typeof process.emitWarning === 'function') {
237
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
254
238
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
255
239
  }
256
240
  return 'containeranalysis.googleapis.com';
@@ -278,7 +262,9 @@ class ContainerAnalysisV1Beta1Client {
278
262
  * @returns {string[]} List of default scopes.
279
263
  */
280
264
  static get scopes() {
281
- return ['https://www.googleapis.com/auth/cloud-platform'];
265
+ return [
266
+ 'https://www.googleapis.com/auth/cloud-platform'
267
+ ];
282
268
  }
283
269
  /**
284
270
  * Return the project ID used by this class.
@@ -304,13 +290,10 @@ class ContainerAnalysisV1Beta1Client {
304
290
  options = options || {};
305
291
  options.otherArgs = options.otherArgs || {};
306
292
  options.otherArgs.headers = options.otherArgs.headers || {};
307
- options.otherArgs.headers['x-goog-request-params'] =
308
- this._gaxModule.routingHeader.fromParams({
309
- resource: request.resource ?? '',
310
- });
311
- this.initialize().catch(err => {
312
- throw err;
293
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
294
+ 'resource': request.resource ?? '',
313
295
  });
296
+ this.initialize().catch(err => { throw err; });
314
297
  this._log.info('setIamPolicy request %j', request);
315
298
  const wrappedCallback = callback
316
299
  ? (error, response, options, rawResponse) => {
@@ -318,11 +301,16 @@ class ContainerAnalysisV1Beta1Client {
318
301
  callback(error, response, options, rawResponse); // We verified callback above.
319
302
  }
320
303
  : undefined;
321
- return this.innerApiCalls
322
- .setIamPolicy(request, options, wrappedCallback)
304
+ return this.innerApiCalls.setIamPolicy(request, options, wrappedCallback)
323
305
  ?.then(([response, options, rawResponse]) => {
324
306
  this._log.info('setIamPolicy response %j', response);
325
307
  return [response, options, rawResponse];
308
+ }).catch((error) => {
309
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
310
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
311
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
312
+ }
313
+ throw error;
326
314
  });
327
315
  }
328
316
  getIamPolicy(request, optionsOrCallback, callback) {
@@ -338,13 +326,10 @@ class ContainerAnalysisV1Beta1Client {
338
326
  options = options || {};
339
327
  options.otherArgs = options.otherArgs || {};
340
328
  options.otherArgs.headers = options.otherArgs.headers || {};
341
- options.otherArgs.headers['x-goog-request-params'] =
342
- this._gaxModule.routingHeader.fromParams({
343
- resource: request.resource ?? '',
344
- });
345
- this.initialize().catch(err => {
346
- throw err;
329
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
330
+ 'resource': request.resource ?? '',
347
331
  });
332
+ this.initialize().catch(err => { throw err; });
348
333
  this._log.info('getIamPolicy request %j', request);
349
334
  const wrappedCallback = callback
350
335
  ? (error, response, options, rawResponse) => {
@@ -352,11 +337,16 @@ class ContainerAnalysisV1Beta1Client {
352
337
  callback(error, response, options, rawResponse); // We verified callback above.
353
338
  }
354
339
  : undefined;
355
- return this.innerApiCalls
356
- .getIamPolicy(request, options, wrappedCallback)
340
+ return this.innerApiCalls.getIamPolicy(request, options, wrappedCallback)
357
341
  ?.then(([response, options, rawResponse]) => {
358
342
  this._log.info('getIamPolicy response %j', response);
359
343
  return [response, options, rawResponse];
344
+ }).catch((error) => {
345
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
346
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
347
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
348
+ }
349
+ throw error;
360
350
  });
361
351
  }
362
352
  testIamPermissions(request, optionsOrCallback, callback) {
@@ -372,13 +362,10 @@ class ContainerAnalysisV1Beta1Client {
372
362
  options = options || {};
373
363
  options.otherArgs = options.otherArgs || {};
374
364
  options.otherArgs.headers = options.otherArgs.headers || {};
375
- options.otherArgs.headers['x-goog-request-params'] =
376
- this._gaxModule.routingHeader.fromParams({
377
- resource: request.resource ?? '',
378
- });
379
- this.initialize().catch(err => {
380
- throw err;
365
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
366
+ 'resource': request.resource ?? '',
381
367
  });
368
+ this.initialize().catch(err => { throw err; });
382
369
  this._log.info('testIamPermissions request %j', request);
383
370
  const wrappedCallback = callback
384
371
  ? (error, response, options, rawResponse) => {
@@ -386,11 +373,16 @@ class ContainerAnalysisV1Beta1Client {
386
373
  callback(error, response, options, rawResponse); // We verified callback above.
387
374
  }
388
375
  : undefined;
389
- return this.innerApiCalls
390
- .testIamPermissions(request, options, wrappedCallback)
376
+ return this.innerApiCalls.testIamPermissions(request, options, wrappedCallback)
391
377
  ?.then(([response, options, rawResponse]) => {
392
378
  this._log.info('testIamPermissions response %j', response);
393
379
  return [response, options, rawResponse];
380
+ }).catch((error) => {
381
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
382
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
383
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
384
+ }
385
+ throw error;
394
386
  });
395
387
  }
396
388
  generatePackagesSummary(request, optionsOrCallback, callback) {
@@ -406,13 +398,10 @@ class ContainerAnalysisV1Beta1Client {
406
398
  options = options || {};
407
399
  options.otherArgs = options.otherArgs || {};
408
400
  options.otherArgs.headers = options.otherArgs.headers || {};
409
- options.otherArgs.headers['x-goog-request-params'] =
410
- this._gaxModule.routingHeader.fromParams({
411
- name: request.name ?? '',
412
- });
413
- this.initialize().catch(err => {
414
- throw err;
401
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
402
+ 'name': request.name ?? '',
415
403
  });
404
+ this.initialize().catch(err => { throw err; });
416
405
  this._log.info('generatePackagesSummary request %j', request);
417
406
  const wrappedCallback = callback
418
407
  ? (error, response, options, rawResponse) => {
@@ -420,11 +409,16 @@ class ContainerAnalysisV1Beta1Client {
420
409
  callback(error, response, options, rawResponse); // We verified callback above.
421
410
  }
422
411
  : undefined;
423
- return this.innerApiCalls
424
- .generatePackagesSummary(request, options, wrappedCallback)
412
+ return this.innerApiCalls.generatePackagesSummary(request, options, wrappedCallback)
425
413
  ?.then(([response, options, rawResponse]) => {
426
414
  this._log.info('generatePackagesSummary response %j', response);
427
415
  return [response, options, rawResponse];
416
+ }).catch((error) => {
417
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
418
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
419
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
420
+ }
421
+ throw error;
428
422
  });
429
423
  }
430
424
  exportSBOM(request, optionsOrCallback, callback) {
@@ -440,13 +434,10 @@ class ContainerAnalysisV1Beta1Client {
440
434
  options = options || {};
441
435
  options.otherArgs = options.otherArgs || {};
442
436
  options.otherArgs.headers = options.otherArgs.headers || {};
443
- options.otherArgs.headers['x-goog-request-params'] =
444
- this._gaxModule.routingHeader.fromParams({
445
- name: request.name ?? '',
446
- });
447
- this.initialize().catch(err => {
448
- throw err;
437
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
438
+ 'name': request.name ?? '',
449
439
  });
440
+ this.initialize().catch(err => { throw err; });
450
441
  this._log.info('exportSBOM request %j', request);
451
442
  const wrappedCallback = callback
452
443
  ? (error, response, options, rawResponse) => {
@@ -454,11 +445,16 @@ class ContainerAnalysisV1Beta1Client {
454
445
  callback(error, response, options, rawResponse); // We verified callback above.
455
446
  }
456
447
  : undefined;
457
- return this.innerApiCalls
458
- .exportSboM(request, options, wrappedCallback)
448
+ return this.innerApiCalls.exportSboM(request, options, wrappedCallback)
459
449
  ?.then(([response, options, rawResponse]) => {
460
450
  this._log.info('exportSBOM response %j', response);
461
451
  return [response, options, rawResponse];
452
+ }).catch((error) => {
453
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
454
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
455
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
456
+ }
457
+ throw error;
462
458
  });
463
459
  }
464
460
  /**
@@ -431,37 +431,37 @@ export declare class GrafeasV1Beta1Client {
431
431
  */
432
432
  getVulnerabilityOccurrencesSummary(request?: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, options?: CallOptions): Promise<[
433
433
  protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary,
434
- (protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | undefined),
434
+ protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | undefined,
435
435
  {} | undefined
436
436
  ]>;
437
437
  getVulnerabilityOccurrencesSummary(request: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
438
438
  getVulnerabilityOccurrencesSummary(request: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, callback: Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
439
439
  /**
440
- * Lists occurrences for the specified project.
441
- *
442
- * @param {Object} request
443
- * The request object that will be sent.
444
- * @param {string} request.parent
445
- * The name of the project to list occurrences for in the form of
446
- * `projects/[PROJECT_ID]`.
447
- * @param {string} request.filter
448
- * The filter expression.
449
- * @param {number} request.pageSize
450
- * Number of occurrences to return in the list.
451
- * @param {string} request.pageToken
452
- * Token to provide to skip to a particular spot in the list.
453
- * @param {object} [options]
454
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
455
- * @returns {Promise} - The promise which resolves to an array.
456
- * The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
457
- * The client library will perform auto-pagination by default: it will call the API as many
458
- * times as needed and will merge results from all the pages into this array.
459
- * Note that it can affect your quota.
460
- * We recommend using `listOccurrencesAsync()`
461
- * method described below for async iteration which you can stop as needed.
462
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
463
- * for more details and examples.
464
- */
440
+ * Lists occurrences for the specified project.
441
+ *
442
+ * @param {Object} request
443
+ * The request object that will be sent.
444
+ * @param {string} request.parent
445
+ * The name of the project to list occurrences for in the form of
446
+ * `projects/[PROJECT_ID]`.
447
+ * @param {string} request.filter
448
+ * The filter expression.
449
+ * @param {number} request.pageSize
450
+ * Number of occurrences to return in the list.
451
+ * @param {string} request.pageToken
452
+ * Token to provide to skip to a particular spot in the list.
453
+ * @param {object} [options]
454
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
455
+ * @returns {Promise} - The promise which resolves to an array.
456
+ * The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
457
+ * The client library will perform auto-pagination by default: it will call the API as many
458
+ * times as needed and will merge results from all the pages into this array.
459
+ * Note that it can affect your quota.
460
+ * We recommend using `listOccurrencesAsync()`
461
+ * method described below for async iteration which you can stop as needed.
462
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
463
+ * for more details and examples.
464
+ */
465
465
  listOccurrences(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): Promise<[
466
466
  protos.grafeas.v1beta1.IOccurrence[],
467
467
  protos.grafeas.v1beta1.IListOccurrencesRequest | null,
@@ -523,31 +523,31 @@ export declare class GrafeasV1Beta1Client {
523
523
  */
524
524
  listOccurrencesAsync(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1beta1.IOccurrence>;
525
525
  /**
526
- * Lists notes for the specified project.
527
- *
528
- * @param {Object} request
529
- * The request object that will be sent.
530
- * @param {string} request.parent
531
- * The name of the project to list notes for in the form of
532
- * `projects/[PROJECT_ID]`.
533
- * @param {string} request.filter
534
- * The filter expression.
535
- * @param {number} request.pageSize
536
- * Number of notes to return in the list.
537
- * @param {string} request.pageToken
538
- * Token to provide to skip to a particular spot in the list.
539
- * @param {object} [options]
540
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
541
- * @returns {Promise} - The promise which resolves to an array.
542
- * The first element of the array is Array of {@link protos.grafeas.v1beta1.Note|Note}.
543
- * The client library will perform auto-pagination by default: it will call the API as many
544
- * times as needed and will merge results from all the pages into this array.
545
- * Note that it can affect your quota.
546
- * We recommend using `listNotesAsync()`
547
- * method described below for async iteration which you can stop as needed.
548
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
549
- * for more details and examples.
550
- */
526
+ * Lists notes for the specified project.
527
+ *
528
+ * @param {Object} request
529
+ * The request object that will be sent.
530
+ * @param {string} request.parent
531
+ * The name of the project to list notes for in the form of
532
+ * `projects/[PROJECT_ID]`.
533
+ * @param {string} request.filter
534
+ * The filter expression.
535
+ * @param {number} request.pageSize
536
+ * Number of notes to return in the list.
537
+ * @param {string} request.pageToken
538
+ * Token to provide to skip to a particular spot in the list.
539
+ * @param {object} [options]
540
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
541
+ * @returns {Promise} - The promise which resolves to an array.
542
+ * The first element of the array is Array of {@link protos.grafeas.v1beta1.Note|Note}.
543
+ * The client library will perform auto-pagination by default: it will call the API as many
544
+ * times as needed and will merge results from all the pages into this array.
545
+ * Note that it can affect your quota.
546
+ * We recommend using `listNotesAsync()`
547
+ * method described below for async iteration which you can stop as needed.
548
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
549
+ * for more details and examples.
550
+ */
551
551
  listNotes(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): Promise<[
552
552
  protos.grafeas.v1beta1.INote[],
553
553
  protos.grafeas.v1beta1.IListNotesRequest | null,
@@ -609,33 +609,33 @@ export declare class GrafeasV1Beta1Client {
609
609
  */
610
610
  listNotesAsync(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1beta1.INote>;
611
611
  /**
612
- * Lists occurrences referencing the specified note. Provider projects can use
613
- * this method to get all occurrences across consumer projects referencing the
614
- * specified note.
615
- *
616
- * @param {Object} request
617
- * The request object that will be sent.
618
- * @param {string} request.name
619
- * The name of the note to list occurrences for in the form of
620
- * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
621
- * @param {string} request.filter
622
- * The filter expression.
623
- * @param {number} request.pageSize
624
- * Number of occurrences to return in the list.
625
- * @param {string} request.pageToken
626
- * Token to provide to skip to a particular spot in the list.
627
- * @param {object} [options]
628
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
629
- * @returns {Promise} - The promise which resolves to an array.
630
- * The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
631
- * The client library will perform auto-pagination by default: it will call the API as many
632
- * times as needed and will merge results from all the pages into this array.
633
- * Note that it can affect your quota.
634
- * We recommend using `listNoteOccurrencesAsync()`
635
- * method described below for async iteration which you can stop as needed.
636
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
637
- * for more details and examples.
638
- */
612
+ * Lists occurrences referencing the specified note. Provider projects can use
613
+ * this method to get all occurrences across consumer projects referencing the
614
+ * specified note.
615
+ *
616
+ * @param {Object} request
617
+ * The request object that will be sent.
618
+ * @param {string} request.name
619
+ * The name of the note to list occurrences for in the form of
620
+ * `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
621
+ * @param {string} request.filter
622
+ * The filter expression.
623
+ * @param {number} request.pageSize
624
+ * Number of occurrences to return in the list.
625
+ * @param {string} request.pageToken
626
+ * Token to provide to skip to a particular spot in the list.
627
+ * @param {object} [options]
628
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
629
+ * @returns {Promise} - The promise which resolves to an array.
630
+ * The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
631
+ * The client library will perform auto-pagination by default: it will call the API as many
632
+ * times as needed and will merge results from all the pages into this array.
633
+ * Note that it can affect your quota.
634
+ * We recommend using `listNoteOccurrencesAsync()`
635
+ * method described below for async iteration which you can stop as needed.
636
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
637
+ * for more details and examples.
638
+ */
639
639
  listNoteOccurrences(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[
640
640
  protos.grafeas.v1beta1.IOccurrence[],
641
641
  protos.grafeas.v1beta1.IListNoteOccurrencesRequest | null,