@google-cloud/containeranalysis 4.7.0 → 5.1.1
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.
- package/CHANGELOG.md +490 -0
- package/README.md +47 -47
- package/build/protos/google/devtools/containeranalysis/v1beta1/containeranalysis.proto +23 -0
- package/build/protos/protos.d.ts +215 -0
- package/build/protos/protos.js +439 -0
- package/build/protos/protos.json +7148 -1
- package/build/src/v1/container_analysis_client.d.ts +10 -15
- package/build/src/v1/container_analysis_client.js +3 -4
- package/build/src/v1beta1/container_analysis_v1_beta1_client.d.ts +34 -15
- package/build/src/v1beta1/container_analysis_v1_beta1_client.js +25 -4
- package/build/src/v1beta1/container_analysis_v1_beta1_client_config.json +4 -0
- package/build/src/v1beta1/grafeas_v1_beta1_client.d.ts +47 -69
- package/build/src/v1beta1/grafeas_v1_beta1_client.js +18 -25
- package/package.json +24 -21
- package/build/src/index.js.map +0 -1
- package/build/src/v1/container_analysis_client.js.map +0 -1
- package/build/src/v1/grafeas_client.js.map +0 -1
- package/build/src/v1/index.js.map +0 -1
- package/build/src/v1beta1/container_analysis_v1_beta1_client.js.map +0 -1
- package/build/src/v1beta1/grafeas_v1_beta1_client.js.map +0 -1
- package/build/src/v1beta1/index.js.map +0 -1
|
@@ -66,8 +66,7 @@ export declare class ContainerAnalysisClient {
|
|
|
66
66
|
* API remote host.
|
|
67
67
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
68
68
|
* Follows the structure of {@link gapicConfig}.
|
|
69
|
-
* @param {boolean
|
|
70
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
69
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
71
70
|
* For more information, please check the
|
|
72
71
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
73
72
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
@@ -75,7 +74,7 @@ export declare class ContainerAnalysisClient {
|
|
|
75
74
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
76
75
|
* ```
|
|
77
76
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
78
|
-
* const client = new ContainerAnalysisClient({fallback:
|
|
77
|
+
* const client = new ContainerAnalysisClient({fallback: true}, gax);
|
|
79
78
|
* ```
|
|
80
79
|
*/
|
|
81
80
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
@@ -146,9 +145,8 @@ export declare class ContainerAnalysisClient {
|
|
|
146
145
|
* @param {object} [options]
|
|
147
146
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
148
147
|
* @returns {Promise} - The promise which resolves to an array.
|
|
149
|
-
* The first element of the array is an object representing {@link google.iam.v1.Policy
|
|
150
|
-
* Please see the
|
|
151
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
148
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
|
|
149
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
152
150
|
* for more details and examples.
|
|
153
151
|
* @example <caption>include:samples/generated/v1/container_analysis.set_iam_policy.js</caption>
|
|
154
152
|
* region_tag:containeranalysis_v1_generated_ContainerAnalysis_SetIamPolicy_async
|
|
@@ -181,9 +179,8 @@ export declare class ContainerAnalysisClient {
|
|
|
181
179
|
* @param {object} [options]
|
|
182
180
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
183
181
|
* @returns {Promise} - The promise which resolves to an array.
|
|
184
|
-
* The first element of the array is an object representing {@link google.iam.v1.Policy
|
|
185
|
-
* Please see the
|
|
186
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
182
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
|
|
183
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
187
184
|
* for more details and examples.
|
|
188
185
|
* @example <caption>include:samples/generated/v1/container_analysis.get_iam_policy.js</caption>
|
|
189
186
|
* region_tag:containeranalysis_v1_generated_ContainerAnalysis_GetIamPolicy_async
|
|
@@ -217,9 +214,8 @@ export declare class ContainerAnalysisClient {
|
|
|
217
214
|
* @param {object} [options]
|
|
218
215
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
219
216
|
* @returns {Promise} - The promise which resolves to an array.
|
|
220
|
-
* The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse
|
|
221
|
-
* Please see the
|
|
222
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
217
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}.
|
|
218
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
223
219
|
* for more details and examples.
|
|
224
220
|
* @example <caption>include:samples/generated/v1/container_analysis.test_iam_permissions.js</caption>
|
|
225
221
|
* region_tag:containeranalysis_v1_generated_ContainerAnalysis_TestIamPermissions_async
|
|
@@ -244,9 +240,8 @@ export declare class ContainerAnalysisClient {
|
|
|
244
240
|
* @param {object} [options]
|
|
245
241
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
246
242
|
* @returns {Promise} - The promise which resolves to an array.
|
|
247
|
-
* The first element of the array is an object representing {@link google.devtools.containeranalysis.v1.VulnerabilityOccurrencesSummary
|
|
248
|
-
* Please see the
|
|
249
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
243
|
+
* The first element of the array is an object representing {@link protos.google.devtools.containeranalysis.v1.VulnerabilityOccurrencesSummary|VulnerabilityOccurrencesSummary}.
|
|
244
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
250
245
|
* for more details and examples.
|
|
251
246
|
* @example <caption>include:samples/generated/v1/container_analysis.get_vulnerability_occurrences_summary.js</caption>
|
|
252
247
|
* region_tag:containeranalysis_v1_generated_ContainerAnalysis_GetVulnerabilityOccurrencesSummary_async
|
|
@@ -73,8 +73,7 @@ class ContainerAnalysisClient {
|
|
|
73
73
|
* API remote host.
|
|
74
74
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
75
75
|
* Follows the structure of {@link gapicConfig}.
|
|
76
|
-
* @param {boolean
|
|
77
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
76
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
78
77
|
* For more information, please check the
|
|
79
78
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
80
79
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
@@ -82,7 +81,7 @@ class ContainerAnalysisClient {
|
|
|
82
81
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
83
82
|
* ```
|
|
84
83
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
85
|
-
* const client = new ContainerAnalysisClient({fallback:
|
|
84
|
+
* const client = new ContainerAnalysisClient({fallback: true}, gax);
|
|
86
85
|
* ```
|
|
87
86
|
*/
|
|
88
87
|
constructor(opts, gaxInstance) {
|
|
@@ -139,7 +138,7 @@ class ContainerAnalysisClient {
|
|
|
139
138
|
if (!opts.fallback) {
|
|
140
139
|
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
|
|
141
140
|
}
|
|
142
|
-
else
|
|
141
|
+
else {
|
|
143
142
|
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
|
|
144
143
|
}
|
|
145
144
|
if (opts.libName && opts.libVersion) {
|
|
@@ -63,8 +63,7 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
63
63
|
* API remote host.
|
|
64
64
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
65
65
|
* Follows the structure of {@link gapicConfig}.
|
|
66
|
-
* @param {boolean
|
|
67
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
66
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
68
67
|
* For more information, please check the
|
|
69
68
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
70
69
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
@@ -72,7 +71,7 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
72
71
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
73
72
|
* ```
|
|
74
73
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
75
|
-
* const client = new ContainerAnalysisV1Beta1Client({fallback:
|
|
74
|
+
* const client = new ContainerAnalysisV1Beta1Client({fallback: true}, gax);
|
|
76
75
|
* ```
|
|
77
76
|
*/
|
|
78
77
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
@@ -143,9 +142,8 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
143
142
|
* @param {object} [options]
|
|
144
143
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
145
144
|
* @returns {Promise} - The promise which resolves to an array.
|
|
146
|
-
* The first element of the array is an object representing {@link google.iam.v1.Policy
|
|
147
|
-
* Please see the
|
|
148
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
145
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
|
|
146
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
149
147
|
* for more details and examples.
|
|
150
148
|
* @example <caption>include:samples/generated/v1beta1/container_analysis_v1_beta1.set_iam_policy.js</caption>
|
|
151
149
|
* region_tag:containeranalysis_v1beta1_generated_ContainerAnalysisV1Beta1_SetIamPolicy_async
|
|
@@ -178,9 +176,8 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
178
176
|
* @param {object} [options]
|
|
179
177
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
180
178
|
* @returns {Promise} - The promise which resolves to an array.
|
|
181
|
-
* The first element of the array is an object representing {@link google.iam.v1.Policy
|
|
182
|
-
* Please see the
|
|
183
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
179
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}.
|
|
180
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
184
181
|
* for more details and examples.
|
|
185
182
|
* @example <caption>include:samples/generated/v1beta1/container_analysis_v1_beta1.get_iam_policy.js</caption>
|
|
186
183
|
* region_tag:containeranalysis_v1beta1_generated_ContainerAnalysisV1Beta1_GetIamPolicy_async
|
|
@@ -214,9 +211,8 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
214
211
|
* @param {object} [options]
|
|
215
212
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
216
213
|
* @returns {Promise} - The promise which resolves to an array.
|
|
217
|
-
* The first element of the array is an object representing {@link google.iam.v1.TestIamPermissionsResponse
|
|
218
|
-
* Please see the
|
|
219
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
214
|
+
* The first element of the array is an object representing {@link protos.google.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}.
|
|
215
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
220
216
|
* for more details and examples.
|
|
221
217
|
* @example <caption>include:samples/generated/v1beta1/container_analysis_v1_beta1.test_iam_permissions.js</caption>
|
|
222
218
|
* region_tag:containeranalysis_v1beta1_generated_ContainerAnalysisV1Beta1_TestIamPermissions_async
|
|
@@ -239,9 +235,8 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
239
235
|
* @param {object} [options]
|
|
240
236
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
241
237
|
* @returns {Promise} - The promise which resolves to an array.
|
|
242
|
-
* The first element of the array is an object representing {@link google.devtools.containeranalysis.v1beta1.PackagesSummaryResponse
|
|
243
|
-
* Please see the
|
|
244
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
238
|
+
* The first element of the array is an object representing {@link protos.google.devtools.containeranalysis.v1beta1.PackagesSummaryResponse|PackagesSummaryResponse}.
|
|
239
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
245
240
|
* for more details and examples.
|
|
246
241
|
* @example <caption>include:samples/generated/v1beta1/container_analysis_v1_beta1.generate_packages_summary.js</caption>
|
|
247
242
|
* region_tag:containeranalysis_v1beta1_generated_ContainerAnalysisV1Beta1_GeneratePackagesSummary_async
|
|
@@ -253,6 +248,30 @@ export declare class ContainerAnalysisV1Beta1Client {
|
|
|
253
248
|
]>;
|
|
254
249
|
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;
|
|
255
250
|
generatePackagesSummary(request: protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IPackagesSummaryResponse, protos.google.devtools.containeranalysis.v1beta1.IGeneratePackagesSummaryRequest | null | undefined, {} | null | undefined>): void;
|
|
251
|
+
/**
|
|
252
|
+
* Generates an SBOM and other dependency information for the given resource.
|
|
253
|
+
*
|
|
254
|
+
* @param {Object} request
|
|
255
|
+
* The request object that will be sent.
|
|
256
|
+
* @param {string} request.name
|
|
257
|
+
* Required. The name of the resource in the form of
|
|
258
|
+
* `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`.
|
|
259
|
+
* @param {object} [options]
|
|
260
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
261
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
262
|
+
* The first element of the array is an object representing {@link protos.google.devtools.containeranalysis.v1beta1.ExportSBOMResponse|ExportSBOMResponse}.
|
|
263
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
264
|
+
* for more details and examples.
|
|
265
|
+
* @example <caption>include:samples/generated/v1beta1/container_analysis_v1_beta1.export_s_b_o_m.js</caption>
|
|
266
|
+
* region_tag:containeranalysis_v1beta1_generated_ContainerAnalysisV1Beta1_ExportSBOM_async
|
|
267
|
+
*/
|
|
268
|
+
exportSBOM(request?: protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest, options?: CallOptions): Promise<[
|
|
269
|
+
protos.google.devtools.containeranalysis.v1beta1.IExportSBOMResponse,
|
|
270
|
+
(protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest | undefined),
|
|
271
|
+
{} | undefined
|
|
272
|
+
]>;
|
|
273
|
+
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;
|
|
274
|
+
exportSBOM(request: protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1beta1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void;
|
|
256
275
|
/**
|
|
257
276
|
* Terminate the gRPC channel and close the client.
|
|
258
277
|
*
|
|
@@ -72,8 +72,7 @@ class ContainerAnalysisV1Beta1Client {
|
|
|
72
72
|
* API remote host.
|
|
73
73
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
74
74
|
* Follows the structure of {@link gapicConfig}.
|
|
75
|
-
* @param {boolean
|
|
76
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
75
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
77
76
|
* For more information, please check the
|
|
78
77
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
79
78
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
@@ -81,7 +80,7 @@ class ContainerAnalysisV1Beta1Client {
|
|
|
81
80
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
82
81
|
* ```
|
|
83
82
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
84
|
-
* const client = new ContainerAnalysisV1Beta1Client({fallback:
|
|
83
|
+
* const client = new ContainerAnalysisV1Beta1Client({fallback: true}, gax);
|
|
85
84
|
* ```
|
|
86
85
|
*/
|
|
87
86
|
constructor(opts, gaxInstance) {
|
|
@@ -139,7 +138,7 @@ class ContainerAnalysisV1Beta1Client {
|
|
|
139
138
|
if (!opts.fallback) {
|
|
140
139
|
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
|
|
141
140
|
}
|
|
142
|
-
else
|
|
141
|
+
else {
|
|
143
142
|
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
|
|
144
143
|
}
|
|
145
144
|
if (opts.libName && opts.libVersion) {
|
|
@@ -186,6 +185,7 @@ class ContainerAnalysisV1Beta1Client {
|
|
|
186
185
|
'getIamPolicy',
|
|
187
186
|
'testIamPermissions',
|
|
188
187
|
'generatePackagesSummary',
|
|
188
|
+
'exportSboM',
|
|
189
189
|
];
|
|
190
190
|
for (const methodName of containerAnalysisV1Beta1StubMethods) {
|
|
191
191
|
const callPromise = this.containerAnalysisV1Beta1Stub.then(stub => (...args) => {
|
|
@@ -328,6 +328,27 @@ class ContainerAnalysisV1Beta1Client {
|
|
|
328
328
|
this.initialize();
|
|
329
329
|
return this.innerApiCalls.generatePackagesSummary(request, options, callback);
|
|
330
330
|
}
|
|
331
|
+
exportSBOM(request, optionsOrCallback, callback) {
|
|
332
|
+
var _a;
|
|
333
|
+
request = request || {};
|
|
334
|
+
let options;
|
|
335
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
|
336
|
+
callback = optionsOrCallback;
|
|
337
|
+
options = {};
|
|
338
|
+
}
|
|
339
|
+
else {
|
|
340
|
+
options = optionsOrCallback;
|
|
341
|
+
}
|
|
342
|
+
options = options || {};
|
|
343
|
+
options.otherArgs = options.otherArgs || {};
|
|
344
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
|
345
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
|
346
|
+
this._gaxModule.routingHeader.fromParams({
|
|
347
|
+
name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
|
|
348
|
+
});
|
|
349
|
+
this.initialize();
|
|
350
|
+
return this.innerApiCalls.exportSboM(request, options, callback);
|
|
351
|
+
}
|
|
331
352
|
/**
|
|
332
353
|
* Terminate the gRPC channel and close the client.
|
|
333
354
|
*
|
|
@@ -66,8 +66,7 @@ export declare class GrafeasV1Beta1Client {
|
|
|
66
66
|
* API remote host.
|
|
67
67
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
68
68
|
* Follows the structure of {@link gapicConfig}.
|
|
69
|
-
* @param {boolean
|
|
70
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
69
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
71
70
|
* For more information, please check the
|
|
72
71
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
73
72
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
@@ -75,7 +74,7 @@ export declare class GrafeasV1Beta1Client {
|
|
|
75
74
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
76
75
|
* ```
|
|
77
76
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
78
|
-
* const client = new GrafeasV1Beta1Client({fallback:
|
|
77
|
+
* const client = new GrafeasV1Beta1Client({fallback: true}, gax);
|
|
79
78
|
* ```
|
|
80
79
|
*/
|
|
81
80
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
@@ -128,9 +127,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
128
127
|
* @param {object} [options]
|
|
129
128
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
130
129
|
* @returns {Promise} - The promise which resolves to an array.
|
|
131
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Occurrence
|
|
132
|
-
* Please see the
|
|
133
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
130
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
|
|
131
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
134
132
|
* for more details and examples.
|
|
135
133
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence.js</caption>
|
|
136
134
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_GetOccurrence_async
|
|
@@ -155,9 +153,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
155
153
|
* @param {object} [options]
|
|
156
154
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
157
155
|
* @returns {Promise} - The promise which resolves to an array.
|
|
158
|
-
* The first element of the array is an object representing {@link google.protobuf.Empty
|
|
159
|
-
* Please see the
|
|
160
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
156
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
157
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
161
158
|
* for more details and examples.
|
|
162
159
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.delete_occurrence.js</caption>
|
|
163
160
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_DeleteOccurrence_async
|
|
@@ -182,9 +179,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
182
179
|
* @param {object} [options]
|
|
183
180
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
184
181
|
* @returns {Promise} - The promise which resolves to an array.
|
|
185
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Occurrence
|
|
186
|
-
* Please see the
|
|
187
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
182
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
|
|
183
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
188
184
|
* for more details and examples.
|
|
189
185
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.create_occurrence.js</caption>
|
|
190
186
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_CreateOccurrence_async
|
|
@@ -209,9 +205,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
209
205
|
* @param {object} [options]
|
|
210
206
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
211
207
|
* @returns {Promise} - The promise which resolves to an array.
|
|
212
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.BatchCreateOccurrencesResponse
|
|
213
|
-
* Please see the
|
|
214
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
208
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.BatchCreateOccurrencesResponse|BatchCreateOccurrencesResponse}.
|
|
209
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
215
210
|
* for more details and examples.
|
|
216
211
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.batch_create_occurrences.js</caption>
|
|
217
212
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_BatchCreateOccurrences_async
|
|
@@ -238,9 +233,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
238
233
|
* @param {object} [options]
|
|
239
234
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
240
235
|
* @returns {Promise} - The promise which resolves to an array.
|
|
241
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Occurrence
|
|
242
|
-
* Please see the
|
|
243
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
236
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
|
|
237
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
244
238
|
* for more details and examples.
|
|
245
239
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.update_occurrence.js</caption>
|
|
246
240
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_UpdateOccurrence_async
|
|
@@ -264,9 +258,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
264
258
|
* @param {object} [options]
|
|
265
259
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
266
260
|
* @returns {Promise} - The promise which resolves to an array.
|
|
267
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Note
|
|
268
|
-
* Please see the
|
|
269
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
261
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Note|Note}.
|
|
262
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
270
263
|
* for more details and examples.
|
|
271
264
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence_note.js</caption>
|
|
272
265
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_GetOccurrenceNote_async
|
|
@@ -289,9 +282,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
289
282
|
* @param {object} [options]
|
|
290
283
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
291
284
|
* @returns {Promise} - The promise which resolves to an array.
|
|
292
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Note
|
|
293
|
-
* Please see the
|
|
294
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
285
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Note|Note}.
|
|
286
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
295
287
|
* for more details and examples.
|
|
296
288
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.get_note.js</caption>
|
|
297
289
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_GetNote_async
|
|
@@ -314,9 +306,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
314
306
|
* @param {object} [options]
|
|
315
307
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
316
308
|
* @returns {Promise} - The promise which resolves to an array.
|
|
317
|
-
* The first element of the array is an object representing {@link google.protobuf.Empty
|
|
318
|
-
* Please see the
|
|
319
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
309
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
310
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
320
311
|
* for more details and examples.
|
|
321
312
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.delete_note.js</caption>
|
|
322
313
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_DeleteNote_async
|
|
@@ -343,9 +334,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
343
334
|
* @param {object} [options]
|
|
344
335
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
345
336
|
* @returns {Promise} - The promise which resolves to an array.
|
|
346
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Note
|
|
347
|
-
* Please see the
|
|
348
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
337
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Note|Note}.
|
|
338
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
349
339
|
* for more details and examples.
|
|
350
340
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.create_note.js</caption>
|
|
351
341
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_CreateNote_async
|
|
@@ -370,9 +360,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
370
360
|
* @param {object} [options]
|
|
371
361
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
372
362
|
* @returns {Promise} - The promise which resolves to an array.
|
|
373
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.BatchCreateNotesResponse
|
|
374
|
-
* Please see the
|
|
375
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
363
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.BatchCreateNotesResponse|BatchCreateNotesResponse}.
|
|
364
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
376
365
|
* for more details and examples.
|
|
377
366
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.batch_create_notes.js</caption>
|
|
378
367
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_BatchCreateNotes_async
|
|
@@ -399,9 +388,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
399
388
|
* @param {object} [options]
|
|
400
389
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
401
390
|
* @returns {Promise} - The promise which resolves to an array.
|
|
402
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.Note
|
|
403
|
-
* Please see the
|
|
404
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
391
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.Note|Note}.
|
|
392
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
405
393
|
* for more details and examples.
|
|
406
394
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.update_note.js</caption>
|
|
407
395
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_UpdateNote_async
|
|
@@ -426,9 +414,8 @@ export declare class GrafeasV1Beta1Client {
|
|
|
426
414
|
* @param {object} [options]
|
|
427
415
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
428
416
|
* @returns {Promise} - The promise which resolves to an array.
|
|
429
|
-
* The first element of the array is an object representing {@link grafeas.v1beta1.VulnerabilityOccurrencesSummary
|
|
430
|
-
* Please see the
|
|
431
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
417
|
+
* The first element of the array is an object representing {@link protos.grafeas.v1beta1.VulnerabilityOccurrencesSummary|VulnerabilityOccurrencesSummary}.
|
|
418
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
432
419
|
* for more details and examples.
|
|
433
420
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.get_vulnerability_occurrences_summary.js</caption>
|
|
434
421
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_GetVulnerabilityOccurrencesSummary_async
|
|
@@ -457,14 +444,13 @@ export declare class GrafeasV1Beta1Client {
|
|
|
457
444
|
* @param {object} [options]
|
|
458
445
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
459
446
|
* @returns {Promise} - The promise which resolves to an array.
|
|
460
|
-
* The first element of the array is Array of {@link grafeas.v1beta1.Occurrence
|
|
447
|
+
* The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
|
|
461
448
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
462
449
|
* times as needed and will merge results from all the pages into this array.
|
|
463
450
|
* Note that it can affect your quota.
|
|
464
451
|
* We recommend using `listOccurrencesAsync()`
|
|
465
452
|
* method described below for async iteration which you can stop as needed.
|
|
466
|
-
* Please see the
|
|
467
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
453
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
468
454
|
* for more details and examples.
|
|
469
455
|
*/
|
|
470
456
|
listOccurrences(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): Promise<[
|
|
@@ -490,13 +476,12 @@ export declare class GrafeasV1Beta1Client {
|
|
|
490
476
|
* @param {object} [options]
|
|
491
477
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
492
478
|
* @returns {Stream}
|
|
493
|
-
* An object stream which emits an object representing {@link grafeas.v1beta1.Occurrence
|
|
479
|
+
* An object stream which emits an object representing {@link protos.grafeas.v1beta1.Occurrence|Occurrence} on 'data' event.
|
|
494
480
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
495
481
|
* times as needed. Note that it can affect your quota.
|
|
496
482
|
* We recommend using `listOccurrencesAsync()`
|
|
497
483
|
* method described below for async iteration which you can stop as needed.
|
|
498
|
-
* Please see the
|
|
499
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
484
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
500
485
|
* for more details and examples.
|
|
501
486
|
*/
|
|
502
487
|
listOccurrencesStream(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): Transform;
|
|
@@ -518,12 +503,11 @@ export declare class GrafeasV1Beta1Client {
|
|
|
518
503
|
* @param {object} [options]
|
|
519
504
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
520
505
|
* @returns {Object}
|
|
521
|
-
* An iterable Object that allows
|
|
506
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
522
507
|
* When you iterate the returned iterable, each element will be an object representing
|
|
523
|
-
* {@link grafeas.v1beta1.Occurrence
|
|
508
|
+
* {@link protos.grafeas.v1beta1.Occurrence|Occurrence}. The API will be called under the hood as needed, once per the page,
|
|
524
509
|
* so you can stop the iteration when you don't need more results.
|
|
525
|
-
* Please see the
|
|
526
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
510
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
527
511
|
* for more details and examples.
|
|
528
512
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.list_occurrences.js</caption>
|
|
529
513
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_ListOccurrences_async
|
|
@@ -546,14 +530,13 @@ export declare class GrafeasV1Beta1Client {
|
|
|
546
530
|
* @param {object} [options]
|
|
547
531
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
548
532
|
* @returns {Promise} - The promise which resolves to an array.
|
|
549
|
-
* The first element of the array is Array of {@link grafeas.v1beta1.Note
|
|
533
|
+
* The first element of the array is Array of {@link protos.grafeas.v1beta1.Note|Note}.
|
|
550
534
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
551
535
|
* times as needed and will merge results from all the pages into this array.
|
|
552
536
|
* Note that it can affect your quota.
|
|
553
537
|
* We recommend using `listNotesAsync()`
|
|
554
538
|
* method described below for async iteration which you can stop as needed.
|
|
555
|
-
* Please see the
|
|
556
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
539
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
557
540
|
* for more details and examples.
|
|
558
541
|
*/
|
|
559
542
|
listNotes(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): Promise<[
|
|
@@ -579,13 +562,12 @@ export declare class GrafeasV1Beta1Client {
|
|
|
579
562
|
* @param {object} [options]
|
|
580
563
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
581
564
|
* @returns {Stream}
|
|
582
|
-
* An object stream which emits an object representing {@link grafeas.v1beta1.Note
|
|
565
|
+
* An object stream which emits an object representing {@link protos.grafeas.v1beta1.Note|Note} on 'data' event.
|
|
583
566
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
584
567
|
* times as needed. Note that it can affect your quota.
|
|
585
568
|
* We recommend using `listNotesAsync()`
|
|
586
569
|
* method described below for async iteration which you can stop as needed.
|
|
587
|
-
* Please see the
|
|
588
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
570
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
589
571
|
* for more details and examples.
|
|
590
572
|
*/
|
|
591
573
|
listNotesStream(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): Transform;
|
|
@@ -607,12 +589,11 @@ export declare class GrafeasV1Beta1Client {
|
|
|
607
589
|
* @param {object} [options]
|
|
608
590
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
609
591
|
* @returns {Object}
|
|
610
|
-
* An iterable Object that allows
|
|
592
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
611
593
|
* When you iterate the returned iterable, each element will be an object representing
|
|
612
|
-
* {@link grafeas.v1beta1.Note
|
|
594
|
+
* {@link protos.grafeas.v1beta1.Note|Note}. The API will be called under the hood as needed, once per the page,
|
|
613
595
|
* so you can stop the iteration when you don't need more results.
|
|
614
|
-
* Please see the
|
|
615
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
596
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
616
597
|
* for more details and examples.
|
|
617
598
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.list_notes.js</caption>
|
|
618
599
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_ListNotes_async
|
|
@@ -637,14 +618,13 @@ export declare class GrafeasV1Beta1Client {
|
|
|
637
618
|
* @param {object} [options]
|
|
638
619
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
639
620
|
* @returns {Promise} - The promise which resolves to an array.
|
|
640
|
-
* The first element of the array is Array of {@link grafeas.v1beta1.Occurrence
|
|
621
|
+
* The first element of the array is Array of {@link protos.grafeas.v1beta1.Occurrence|Occurrence}.
|
|
641
622
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
642
623
|
* times as needed and will merge results from all the pages into this array.
|
|
643
624
|
* Note that it can affect your quota.
|
|
644
625
|
* We recommend using `listNoteOccurrencesAsync()`
|
|
645
626
|
* method described below for async iteration which you can stop as needed.
|
|
646
|
-
* Please see the
|
|
647
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
627
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
648
628
|
* for more details and examples.
|
|
649
629
|
*/
|
|
650
630
|
listNoteOccurrences(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[
|
|
@@ -670,13 +650,12 @@ export declare class GrafeasV1Beta1Client {
|
|
|
670
650
|
* @param {object} [options]
|
|
671
651
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
672
652
|
* @returns {Stream}
|
|
673
|
-
* An object stream which emits an object representing {@link grafeas.v1beta1.Occurrence
|
|
653
|
+
* An object stream which emits an object representing {@link protos.grafeas.v1beta1.Occurrence|Occurrence} on 'data' event.
|
|
674
654
|
* The client library will perform auto-pagination by default: it will call the API as many
|
|
675
655
|
* times as needed. Note that it can affect your quota.
|
|
676
656
|
* We recommend using `listNoteOccurrencesAsync()`
|
|
677
657
|
* method described below for async iteration which you can stop as needed.
|
|
678
|
-
* Please see the
|
|
679
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
658
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
680
659
|
* for more details and examples.
|
|
681
660
|
*/
|
|
682
661
|
listNoteOccurrencesStream(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): Transform;
|
|
@@ -698,12 +677,11 @@ export declare class GrafeasV1Beta1Client {
|
|
|
698
677
|
* @param {object} [options]
|
|
699
678
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
700
679
|
* @returns {Object}
|
|
701
|
-
* An iterable Object that allows
|
|
680
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
702
681
|
* When you iterate the returned iterable, each element will be an object representing
|
|
703
|
-
* {@link grafeas.v1beta1.Occurrence
|
|
682
|
+
* {@link protos.grafeas.v1beta1.Occurrence|Occurrence}. The API will be called under the hood as needed, once per the page,
|
|
704
683
|
* so you can stop the iteration when you don't need more results.
|
|
705
|
-
* Please see the
|
|
706
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
684
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
707
685
|
* for more details and examples.
|
|
708
686
|
* @example <caption>include:samples/generated/v1beta1/grafeas_v1_beta1.list_note_occurrences.js</caption>
|
|
709
687
|
* region_tag:containeranalysis_v1beta1_generated_GrafeasV1Beta1_ListNoteOccurrences_async
|