@google-cloud/containeranalysis 5.1.1 → 5.2.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.
- package/CHANGELOG.md +7 -0
- package/build/protos/protos.d.ts +1 -1
- package/build/protos/protos.js +1 -1
- package/build/src/index.js +1 -1
- package/build/src/v1/container_analysis_client.d.ts +11 -2
- package/build/src/v1/container_analysis_client.js +37 -10
- package/build/src/v1beta1/container_analysis_v1_beta1_client.d.ts +11 -2
- package/build/src/v1beta1/container_analysis_v1_beta1_client.js +37 -10
- package/build/src/v1beta1/grafeas_v1_beta1_client.d.ts +11 -2
- package/build/src/v1beta1/grafeas_v1_beta1_client.js +37 -10
- package/package.json +6 -6
- package/build/src/v1/grafeas_client.d.ts +0 -764
- package/build/src/v1/grafeas_client.js +0 -928
- package/build/src/v1/grafeas_client_config.json +0 -82
|
@@ -1,764 +0,0 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
import type * as gax from 'google-gax';
|
|
3
|
-
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
|
4
|
-
import { Transform } from 'stream';
|
|
5
|
-
import * as protos from '../../protos/protos';
|
|
6
|
-
/**
|
|
7
|
-
* [Grafeas](https://grafeas.io) API.
|
|
8
|
-
*
|
|
9
|
-
* Retrieves analysis results of Cloud components such as Docker container
|
|
10
|
-
* images.
|
|
11
|
-
*
|
|
12
|
-
* Analysis results are stored as a series of occurrences. An `Occurrence`
|
|
13
|
-
* contains information about a specific analysis instance on a resource. An
|
|
14
|
-
* occurrence refers to a `Note`. A note contains details describing the
|
|
15
|
-
* analysis and is generally stored in a separate project, called a `Provider`.
|
|
16
|
-
* Multiple occurrences can refer to the same note.
|
|
17
|
-
*
|
|
18
|
-
* For example, an SSL vulnerability could affect multiple images. In this case,
|
|
19
|
-
* there would be one note for the vulnerability and an occurrence for each
|
|
20
|
-
* image with the vulnerability referring to that note.
|
|
21
|
-
* @class
|
|
22
|
-
* @memberof v1
|
|
23
|
-
*/
|
|
24
|
-
export declare class GrafeasClient {
|
|
25
|
-
private _terminated;
|
|
26
|
-
private _opts;
|
|
27
|
-
private _providedCustomServicePath;
|
|
28
|
-
private _gaxModule;
|
|
29
|
-
private _gaxGrpc;
|
|
30
|
-
private _protos;
|
|
31
|
-
private _defaults;
|
|
32
|
-
auth: gax.GoogleAuth;
|
|
33
|
-
descriptors: Descriptors;
|
|
34
|
-
warn: (code: string, message: string, warnType?: string) => void;
|
|
35
|
-
innerApiCalls: {
|
|
36
|
-
[name: string]: Function;
|
|
37
|
-
};
|
|
38
|
-
pathTemplates: {
|
|
39
|
-
[name: string]: gax.PathTemplate;
|
|
40
|
-
};
|
|
41
|
-
grafeasStub?: Promise<{
|
|
42
|
-
[name: string]: Function;
|
|
43
|
-
}>;
|
|
44
|
-
/**
|
|
45
|
-
* Construct an instance of GrafeasClient.
|
|
46
|
-
*
|
|
47
|
-
* @param {object} [options] - The configuration object.
|
|
48
|
-
* The options accepted by the constructor are described in detail
|
|
49
|
-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
|
50
|
-
* The common options are:
|
|
51
|
-
* @param {object} [options.credentials] - Credentials object.
|
|
52
|
-
* @param {string} [options.credentials.client_email]
|
|
53
|
-
* @param {string} [options.credentials.private_key]
|
|
54
|
-
* @param {string} [options.email] - Account email address. Required when
|
|
55
|
-
* using a .pem or .p12 keyFilename.
|
|
56
|
-
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
|
57
|
-
* .p12 key downloaded from the Google Developers Console. If you provide
|
|
58
|
-
* a path to a JSON file, the projectId option below is not necessary.
|
|
59
|
-
* NOTE: .pem and .p12 require you to specify options.email as well.
|
|
60
|
-
* @param {number} [options.port] - The port on which to connect to
|
|
61
|
-
* the remote host.
|
|
62
|
-
* @param {string} [options.projectId] - The project ID from the Google
|
|
63
|
-
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
|
64
|
-
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
|
65
|
-
* app is running in an environment which supports
|
|
66
|
-
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
|
67
|
-
* your project ID will be detected automatically.
|
|
68
|
-
* @param {string} [options.apiEndpoint] - The domain name of the
|
|
69
|
-
* API remote host.
|
|
70
|
-
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
71
|
-
* Follows the structure of {@link gapicConfig}.
|
|
72
|
-
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
|
|
73
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
|
74
|
-
* For more information, please check the
|
|
75
|
-
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
76
|
-
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
77
|
-
* need to avoid loading the default gRPC version and want to use the fallback
|
|
78
|
-
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
79
|
-
* ```
|
|
80
|
-
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
81
|
-
* const client = new GrafeasClient({fallback: 'rest'}, gax);
|
|
82
|
-
* ```
|
|
83
|
-
*/
|
|
84
|
-
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
85
|
-
/**
|
|
86
|
-
* Initialize the client.
|
|
87
|
-
* Performs asynchronous operations (such as authentication) and prepares the client.
|
|
88
|
-
* This function will be called automatically when any class method is called for the
|
|
89
|
-
* first time, but if you need to initialize it before calling an actual method,
|
|
90
|
-
* feel free to call initialize() directly.
|
|
91
|
-
*
|
|
92
|
-
* You can await on this method if you want to make sure the client is initialized.
|
|
93
|
-
*
|
|
94
|
-
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
|
95
|
-
*/
|
|
96
|
-
initialize(): Promise<{
|
|
97
|
-
[name: string]: Function;
|
|
98
|
-
}>;
|
|
99
|
-
/**
|
|
100
|
-
* The DNS address for this API service.
|
|
101
|
-
* @returns {string} The DNS address for this service.
|
|
102
|
-
*/
|
|
103
|
-
static get servicePath(): string;
|
|
104
|
-
/**
|
|
105
|
-
* The DNS address for this API service - same as servicePath(),
|
|
106
|
-
* exists for compatibility reasons.
|
|
107
|
-
* @returns {string} The DNS address for this service.
|
|
108
|
-
*/
|
|
109
|
-
static get apiEndpoint(): string;
|
|
110
|
-
/**
|
|
111
|
-
* The port for this API service.
|
|
112
|
-
* @returns {number} The default port for this service.
|
|
113
|
-
*/
|
|
114
|
-
static get port(): number;
|
|
115
|
-
/**
|
|
116
|
-
* The scopes needed to make gRPC calls for every method defined
|
|
117
|
-
* in this service.
|
|
118
|
-
* @returns {string[]} List of default scopes.
|
|
119
|
-
*/
|
|
120
|
-
static get scopes(): never[];
|
|
121
|
-
getProjectId(): Promise<string>;
|
|
122
|
-
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
123
|
-
/**
|
|
124
|
-
* Gets the specified occurrence.
|
|
125
|
-
*
|
|
126
|
-
* @param {Object} request
|
|
127
|
-
* The request object that will be sent.
|
|
128
|
-
* @param {string} request.name
|
|
129
|
-
* The name of the occurrence in the form of
|
|
130
|
-
* `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
|
|
131
|
-
* @param {object} [options]
|
|
132
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
133
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
134
|
-
* The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
|
|
135
|
-
* Please see the
|
|
136
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
137
|
-
* for more details and examples.
|
|
138
|
-
* @example <caption>include:samples/generated/v1/grafeas.get_occurrence.js</caption>
|
|
139
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_GetOccurrence_async
|
|
140
|
-
*/
|
|
141
|
-
getOccurrence(request?: protos.grafeas.v1.IGetOccurrenceRequest, options?: CallOptions): Promise<[
|
|
142
|
-
protos.grafeas.v1.IOccurrence,
|
|
143
|
-
protos.grafeas.v1.IGetOccurrenceRequest | undefined,
|
|
144
|
-
{} | undefined
|
|
145
|
-
]>;
|
|
146
|
-
getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
147
|
-
getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
148
|
-
/**
|
|
149
|
-
* Deletes the specified occurrence. For example, use this method to delete an
|
|
150
|
-
* occurrence when the occurrence is no longer applicable for the given
|
|
151
|
-
* resource.
|
|
152
|
-
*
|
|
153
|
-
* @param {Object} request
|
|
154
|
-
* The request object that will be sent.
|
|
155
|
-
* @param {string} request.name
|
|
156
|
-
* The name of the occurrence in the form of
|
|
157
|
-
* `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
|
|
158
|
-
* @param {object} [options]
|
|
159
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
160
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
161
|
-
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
|
|
162
|
-
* Please see the
|
|
163
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
164
|
-
* for more details and examples.
|
|
165
|
-
* @example <caption>include:samples/generated/v1/grafeas.delete_occurrence.js</caption>
|
|
166
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_DeleteOccurrence_async
|
|
167
|
-
*/
|
|
168
|
-
deleteOccurrence(request?: protos.grafeas.v1.IDeleteOccurrenceRequest, options?: CallOptions): Promise<[
|
|
169
|
-
protos.google.protobuf.IEmpty,
|
|
170
|
-
protos.grafeas.v1.IDeleteOccurrenceRequest | undefined,
|
|
171
|
-
{} | undefined
|
|
172
|
-
]>;
|
|
173
|
-
deleteOccurrence(request: protos.grafeas.v1.IDeleteOccurrenceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
174
|
-
deleteOccurrence(request: protos.grafeas.v1.IDeleteOccurrenceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
175
|
-
/**
|
|
176
|
-
* Creates a new occurrence.
|
|
177
|
-
*
|
|
178
|
-
* @param {Object} request
|
|
179
|
-
* The request object that will be sent.
|
|
180
|
-
* @param {string} request.parent
|
|
181
|
-
* The name of the project in the form of `projects/[PROJECT_ID]`, under which
|
|
182
|
-
* the occurrence is to be created.
|
|
183
|
-
* @param {grafeas.v1.Occurrence} request.occurrence
|
|
184
|
-
* The occurrence to create.
|
|
185
|
-
* @param {object} [options]
|
|
186
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
187
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
188
|
-
* The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
|
|
189
|
-
* Please see the
|
|
190
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
191
|
-
* for more details and examples.
|
|
192
|
-
* @example <caption>include:samples/generated/v1/grafeas.create_occurrence.js</caption>
|
|
193
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_CreateOccurrence_async
|
|
194
|
-
*/
|
|
195
|
-
createOccurrence(request?: protos.grafeas.v1.ICreateOccurrenceRequest, options?: CallOptions): Promise<[
|
|
196
|
-
protos.grafeas.v1.IOccurrence,
|
|
197
|
-
protos.grafeas.v1.ICreateOccurrenceRequest | undefined,
|
|
198
|
-
{} | undefined
|
|
199
|
-
]>;
|
|
200
|
-
createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
201
|
-
createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
202
|
-
/**
|
|
203
|
-
* Creates new occurrences in batch.
|
|
204
|
-
*
|
|
205
|
-
* @param {Object} request
|
|
206
|
-
* The request object that will be sent.
|
|
207
|
-
* @param {string} request.parent
|
|
208
|
-
* The name of the project in the form of `projects/[PROJECT_ID]`, under which
|
|
209
|
-
* the occurrences are to be created.
|
|
210
|
-
* @param {number[]} request.occurrences
|
|
211
|
-
* The occurrences to create. Max allowed length is 1000.
|
|
212
|
-
* @param {object} [options]
|
|
213
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
214
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
215
|
-
* The first element of the array is an object representing [BatchCreateOccurrencesResponse]{@link grafeas.v1.BatchCreateOccurrencesResponse}.
|
|
216
|
-
* Please see the
|
|
217
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
218
|
-
* for more details and examples.
|
|
219
|
-
* @example <caption>include:samples/generated/v1/grafeas.batch_create_occurrences.js</caption>
|
|
220
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_BatchCreateOccurrences_async
|
|
221
|
-
*/
|
|
222
|
-
batchCreateOccurrences(request?: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options?: CallOptions): Promise<[
|
|
223
|
-
protos.grafeas.v1.IBatchCreateOccurrencesResponse,
|
|
224
|
-
protos.grafeas.v1.IBatchCreateOccurrencesRequest | undefined,
|
|
225
|
-
{} | undefined
|
|
226
|
-
]>;
|
|
227
|
-
batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
|
|
228
|
-
batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
|
|
229
|
-
/**
|
|
230
|
-
* Updates the specified occurrence.
|
|
231
|
-
*
|
|
232
|
-
* @param {Object} request
|
|
233
|
-
* The request object that will be sent.
|
|
234
|
-
* @param {string} request.name
|
|
235
|
-
* The name of the occurrence in the form of
|
|
236
|
-
* `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
|
|
237
|
-
* @param {grafeas.v1.Occurrence} request.occurrence
|
|
238
|
-
* The updated occurrence.
|
|
239
|
-
* @param {google.protobuf.FieldMask} request.updateMask
|
|
240
|
-
* The fields to update.
|
|
241
|
-
* @param {object} [options]
|
|
242
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
243
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
244
|
-
* The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
|
|
245
|
-
* Please see the
|
|
246
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
247
|
-
* for more details and examples.
|
|
248
|
-
* @example <caption>include:samples/generated/v1/grafeas.update_occurrence.js</caption>
|
|
249
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_UpdateOccurrence_async
|
|
250
|
-
*/
|
|
251
|
-
updateOccurrence(request?: protos.grafeas.v1.IUpdateOccurrenceRequest, options?: CallOptions): Promise<[
|
|
252
|
-
protos.grafeas.v1.IOccurrence,
|
|
253
|
-
protos.grafeas.v1.IUpdateOccurrenceRequest | undefined,
|
|
254
|
-
{} | undefined
|
|
255
|
-
]>;
|
|
256
|
-
updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
257
|
-
updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
|
|
258
|
-
/**
|
|
259
|
-
* Gets the note attached to the specified occurrence. Consumer projects can
|
|
260
|
-
* use this method to get a note that belongs to a provider project.
|
|
261
|
-
*
|
|
262
|
-
* @param {Object} request
|
|
263
|
-
* The request object that will be sent.
|
|
264
|
-
* @param {string} request.name
|
|
265
|
-
* The name of the occurrence in the form of
|
|
266
|
-
* `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
|
|
267
|
-
* @param {object} [options]
|
|
268
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
269
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
270
|
-
* The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
|
|
271
|
-
* Please see the
|
|
272
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
273
|
-
* for more details and examples.
|
|
274
|
-
* @example <caption>include:samples/generated/v1/grafeas.get_occurrence_note.js</caption>
|
|
275
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_GetOccurrenceNote_async
|
|
276
|
-
*/
|
|
277
|
-
getOccurrenceNote(request?: protos.grafeas.v1.IGetOccurrenceNoteRequest, options?: CallOptions): Promise<[
|
|
278
|
-
protos.grafeas.v1.INote,
|
|
279
|
-
protos.grafeas.v1.IGetOccurrenceNoteRequest | undefined,
|
|
280
|
-
{} | undefined
|
|
281
|
-
]>;
|
|
282
|
-
getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
283
|
-
getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
284
|
-
/**
|
|
285
|
-
* Gets the specified note.
|
|
286
|
-
*
|
|
287
|
-
* @param {Object} request
|
|
288
|
-
* The request object that will be sent.
|
|
289
|
-
* @param {string} request.name
|
|
290
|
-
* The name of the note in the form of
|
|
291
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
292
|
-
* @param {object} [options]
|
|
293
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
294
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
295
|
-
* The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
|
|
296
|
-
* Please see the
|
|
297
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
298
|
-
* for more details and examples.
|
|
299
|
-
* @example <caption>include:samples/generated/v1/grafeas.get_note.js</caption>
|
|
300
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_GetNote_async
|
|
301
|
-
*/
|
|
302
|
-
getNote(request?: protos.grafeas.v1.IGetNoteRequest, options?: CallOptions): Promise<[
|
|
303
|
-
protos.grafeas.v1.INote,
|
|
304
|
-
protos.grafeas.v1.IGetNoteRequest | undefined,
|
|
305
|
-
{} | undefined
|
|
306
|
-
]>;
|
|
307
|
-
getNote(request: protos.grafeas.v1.IGetNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
308
|
-
getNote(request: protos.grafeas.v1.IGetNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
309
|
-
/**
|
|
310
|
-
* Deletes the specified note.
|
|
311
|
-
*
|
|
312
|
-
* @param {Object} request
|
|
313
|
-
* The request object that will be sent.
|
|
314
|
-
* @param {string} request.name
|
|
315
|
-
* The name of the note in the form of
|
|
316
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
317
|
-
* @param {object} [options]
|
|
318
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
319
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
320
|
-
* The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
|
|
321
|
-
* Please see the
|
|
322
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
323
|
-
* for more details and examples.
|
|
324
|
-
* @example <caption>include:samples/generated/v1/grafeas.delete_note.js</caption>
|
|
325
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_DeleteNote_async
|
|
326
|
-
*/
|
|
327
|
-
deleteNote(request?: protos.grafeas.v1.IDeleteNoteRequest, options?: CallOptions): Promise<[
|
|
328
|
-
protos.google.protobuf.IEmpty,
|
|
329
|
-
protos.grafeas.v1.IDeleteNoteRequest | undefined,
|
|
330
|
-
{} | undefined
|
|
331
|
-
]>;
|
|
332
|
-
deleteNote(request: protos.grafeas.v1.IDeleteNoteRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
333
|
-
deleteNote(request: protos.grafeas.v1.IDeleteNoteRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
334
|
-
/**
|
|
335
|
-
* Creates a new note.
|
|
336
|
-
*
|
|
337
|
-
* @param {Object} request
|
|
338
|
-
* The request object that will be sent.
|
|
339
|
-
* @param {string} request.parent
|
|
340
|
-
* The name of the project in the form of `projects/[PROJECT_ID]`, under which
|
|
341
|
-
* the note is to be created.
|
|
342
|
-
* @param {string} request.noteId
|
|
343
|
-
* The ID to use for this note.
|
|
344
|
-
* @param {grafeas.v1.Note} request.note
|
|
345
|
-
* The note to create.
|
|
346
|
-
* @param {object} [options]
|
|
347
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
348
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
349
|
-
* The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
|
|
350
|
-
* Please see the
|
|
351
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
352
|
-
* for more details and examples.
|
|
353
|
-
* @example <caption>include:samples/generated/v1/grafeas.create_note.js</caption>
|
|
354
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_CreateNote_async
|
|
355
|
-
*/
|
|
356
|
-
createNote(request?: protos.grafeas.v1.ICreateNoteRequest, options?: CallOptions): Promise<[
|
|
357
|
-
protos.grafeas.v1.INote,
|
|
358
|
-
protos.grafeas.v1.ICreateNoteRequest | undefined,
|
|
359
|
-
{} | undefined
|
|
360
|
-
]>;
|
|
361
|
-
createNote(request: protos.grafeas.v1.ICreateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
362
|
-
createNote(request: protos.grafeas.v1.ICreateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
363
|
-
/**
|
|
364
|
-
* Creates new notes in batch.
|
|
365
|
-
*
|
|
366
|
-
* @param {Object} request
|
|
367
|
-
* The request object that will be sent.
|
|
368
|
-
* @param {string} request.parent
|
|
369
|
-
* The name of the project in the form of `projects/[PROJECT_ID]`, under which
|
|
370
|
-
* the notes are to be created.
|
|
371
|
-
* @param {number[]} request.notes
|
|
372
|
-
* The notes to create. Max allowed length is 1000.
|
|
373
|
-
* @param {object} [options]
|
|
374
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
375
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
376
|
-
* The first element of the array is an object representing [BatchCreateNotesResponse]{@link grafeas.v1.BatchCreateNotesResponse}.
|
|
377
|
-
* Please see the
|
|
378
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
379
|
-
* for more details and examples.
|
|
380
|
-
* @example <caption>include:samples/generated/v1/grafeas.batch_create_notes.js</caption>
|
|
381
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_BatchCreateNotes_async
|
|
382
|
-
*/
|
|
383
|
-
batchCreateNotes(request?: protos.grafeas.v1.IBatchCreateNotesRequest, options?: CallOptions): Promise<[
|
|
384
|
-
protos.grafeas.v1.IBatchCreateNotesResponse,
|
|
385
|
-
protos.grafeas.v1.IBatchCreateNotesRequest | undefined,
|
|
386
|
-
{} | undefined
|
|
387
|
-
]>;
|
|
388
|
-
batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
|
|
389
|
-
batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
|
|
390
|
-
/**
|
|
391
|
-
* Updates the specified note.
|
|
392
|
-
*
|
|
393
|
-
* @param {Object} request
|
|
394
|
-
* The request object that will be sent.
|
|
395
|
-
* @param {string} request.name
|
|
396
|
-
* The name of the note in the form of
|
|
397
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
398
|
-
* @param {grafeas.v1.Note} request.note
|
|
399
|
-
* The updated note.
|
|
400
|
-
* @param {google.protobuf.FieldMask} request.updateMask
|
|
401
|
-
* The fields to update.
|
|
402
|
-
* @param {object} [options]
|
|
403
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
404
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
405
|
-
* The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
|
|
406
|
-
* Please see the
|
|
407
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
|
408
|
-
* for more details and examples.
|
|
409
|
-
* @example <caption>include:samples/generated/v1/grafeas.update_note.js</caption>
|
|
410
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_UpdateNote_async
|
|
411
|
-
*/
|
|
412
|
-
updateNote(request?: protos.grafeas.v1.IUpdateNoteRequest, options?: CallOptions): Promise<[
|
|
413
|
-
protos.grafeas.v1.INote,
|
|
414
|
-
protos.grafeas.v1.IUpdateNoteRequest | undefined,
|
|
415
|
-
{} | undefined
|
|
416
|
-
]>;
|
|
417
|
-
updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
418
|
-
updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
|
|
419
|
-
/**
|
|
420
|
-
* Lists occurrences for the specified project.
|
|
421
|
-
*
|
|
422
|
-
* @param {Object} request
|
|
423
|
-
* The request object that will be sent.
|
|
424
|
-
* @param {string} request.parent
|
|
425
|
-
* The name of the project to list occurrences for in the form of
|
|
426
|
-
* `projects/[PROJECT_ID]`.
|
|
427
|
-
* @param {string} request.filter
|
|
428
|
-
* The filter expression.
|
|
429
|
-
* @param {number} request.pageSize
|
|
430
|
-
* Number of occurrences to return in the list. Must be positive. Max allowed
|
|
431
|
-
* page size is 1000. If not specified, page size defaults to 20.
|
|
432
|
-
* @param {string} request.pageToken
|
|
433
|
-
* Token to provide to skip to a particular spot in the list.
|
|
434
|
-
* @param {object} [options]
|
|
435
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
436
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
437
|
-
* The first element of the array is Array of [Occurrence]{@link grafeas.v1.Occurrence}.
|
|
438
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
439
|
-
* times as needed and will merge results from all the pages into this array.
|
|
440
|
-
* Note that it can affect your quota.
|
|
441
|
-
* We recommend using `listOccurrencesAsync()`
|
|
442
|
-
* method described below for async iteration which you can stop as needed.
|
|
443
|
-
* Please see the
|
|
444
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
445
|
-
* for more details and examples.
|
|
446
|
-
*/
|
|
447
|
-
listOccurrences(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): Promise<[
|
|
448
|
-
protos.grafeas.v1.IOccurrence[],
|
|
449
|
-
protos.grafeas.v1.IListOccurrencesRequest | null,
|
|
450
|
-
protos.grafeas.v1.IListOccurrencesResponse
|
|
451
|
-
]>;
|
|
452
|
-
listOccurrences(request: protos.grafeas.v1.IListOccurrencesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
|
|
453
|
-
listOccurrences(request: protos.grafeas.v1.IListOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
|
|
454
|
-
/**
|
|
455
|
-
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
456
|
-
* @param {Object} request
|
|
457
|
-
* The request object that will be sent.
|
|
458
|
-
* @param {string} request.parent
|
|
459
|
-
* The name of the project to list occurrences for in the form of
|
|
460
|
-
* `projects/[PROJECT_ID]`.
|
|
461
|
-
* @param {string} request.filter
|
|
462
|
-
* The filter expression.
|
|
463
|
-
* @param {number} request.pageSize
|
|
464
|
-
* Number of occurrences to return in the list. Must be positive. Max allowed
|
|
465
|
-
* page size is 1000. If not specified, page size defaults to 20.
|
|
466
|
-
* @param {string} request.pageToken
|
|
467
|
-
* Token to provide to skip to a particular spot in the list.
|
|
468
|
-
* @param {object} [options]
|
|
469
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
470
|
-
* @returns {Stream}
|
|
471
|
-
* An object stream which emits an object representing [Occurrence]{@link grafeas.v1.Occurrence} on 'data' event.
|
|
472
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
473
|
-
* times as needed. Note that it can affect your quota.
|
|
474
|
-
* We recommend using `listOccurrencesAsync()`
|
|
475
|
-
* method described below for async iteration which you can stop as needed.
|
|
476
|
-
* Please see the
|
|
477
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
478
|
-
* for more details and examples.
|
|
479
|
-
*/
|
|
480
|
-
listOccurrencesStream(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): Transform;
|
|
481
|
-
/**
|
|
482
|
-
* Equivalent to `listOccurrences`, but returns an iterable object.
|
|
483
|
-
*
|
|
484
|
-
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
485
|
-
* @param {Object} request
|
|
486
|
-
* The request object that will be sent.
|
|
487
|
-
* @param {string} request.parent
|
|
488
|
-
* The name of the project to list occurrences for in the form of
|
|
489
|
-
* `projects/[PROJECT_ID]`.
|
|
490
|
-
* @param {string} request.filter
|
|
491
|
-
* The filter expression.
|
|
492
|
-
* @param {number} request.pageSize
|
|
493
|
-
* Number of occurrences to return in the list. Must be positive. Max allowed
|
|
494
|
-
* page size is 1000. If not specified, page size defaults to 20.
|
|
495
|
-
* @param {string} request.pageToken
|
|
496
|
-
* Token to provide to skip to a particular spot in the list.
|
|
497
|
-
* @param {object} [options]
|
|
498
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
499
|
-
* @returns {Object}
|
|
500
|
-
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
|
|
501
|
-
* When you iterate the returned iterable, each element will be an object representing
|
|
502
|
-
* [Occurrence]{@link grafeas.v1.Occurrence}. The API will be called under the hood as needed, once per the page,
|
|
503
|
-
* so you can stop the iteration when you don't need more results.
|
|
504
|
-
* Please see the
|
|
505
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
506
|
-
* for more details and examples.
|
|
507
|
-
* @example <caption>include:samples/generated/v1/grafeas.list_occurrences.js</caption>
|
|
508
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_ListOccurrences_async
|
|
509
|
-
*/
|
|
510
|
-
listOccurrencesAsync(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.IOccurrence>;
|
|
511
|
-
/**
|
|
512
|
-
* Lists notes for the specified project.
|
|
513
|
-
*
|
|
514
|
-
* @param {Object} request
|
|
515
|
-
* The request object that will be sent.
|
|
516
|
-
* @param {string} request.parent
|
|
517
|
-
* The name of the project to list notes for in the form of
|
|
518
|
-
* `projects/[PROJECT_ID]`.
|
|
519
|
-
* @param {string} request.filter
|
|
520
|
-
* The filter expression.
|
|
521
|
-
* @param {number} request.pageSize
|
|
522
|
-
* Number of notes to return in the list. Must be positive. Max allowed page
|
|
523
|
-
* size is 1000. If not specified, page size defaults to 20.
|
|
524
|
-
* @param {string} request.pageToken
|
|
525
|
-
* Token to provide to skip to a particular spot in the list.
|
|
526
|
-
* @param {object} [options]
|
|
527
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
528
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
529
|
-
* The first element of the array is Array of [Note]{@link grafeas.v1.Note}.
|
|
530
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
531
|
-
* times as needed and will merge results from all the pages into this array.
|
|
532
|
-
* Note that it can affect your quota.
|
|
533
|
-
* We recommend using `listNotesAsync()`
|
|
534
|
-
* method described below for async iteration which you can stop as needed.
|
|
535
|
-
* Please see the
|
|
536
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
537
|
-
* for more details and examples.
|
|
538
|
-
*/
|
|
539
|
-
listNotes(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): Promise<[
|
|
540
|
-
protos.grafeas.v1.INote[],
|
|
541
|
-
protos.grafeas.v1.IListNotesRequest | null,
|
|
542
|
-
protos.grafeas.v1.IListNotesResponse
|
|
543
|
-
]>;
|
|
544
|
-
listNotes(request: protos.grafeas.v1.IListNotesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>): void;
|
|
545
|
-
listNotes(request: protos.grafeas.v1.IListNotesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>): void;
|
|
546
|
-
/**
|
|
547
|
-
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
548
|
-
* @param {Object} request
|
|
549
|
-
* The request object that will be sent.
|
|
550
|
-
* @param {string} request.parent
|
|
551
|
-
* The name of the project to list notes for in the form of
|
|
552
|
-
* `projects/[PROJECT_ID]`.
|
|
553
|
-
* @param {string} request.filter
|
|
554
|
-
* The filter expression.
|
|
555
|
-
* @param {number} request.pageSize
|
|
556
|
-
* Number of notes to return in the list. Must be positive. Max allowed page
|
|
557
|
-
* size is 1000. If not specified, page size defaults to 20.
|
|
558
|
-
* @param {string} request.pageToken
|
|
559
|
-
* Token to provide to skip to a particular spot in the list.
|
|
560
|
-
* @param {object} [options]
|
|
561
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
562
|
-
* @returns {Stream}
|
|
563
|
-
* An object stream which emits an object representing [Note]{@link grafeas.v1.Note} on 'data' event.
|
|
564
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
565
|
-
* times as needed. Note that it can affect your quota.
|
|
566
|
-
* We recommend using `listNotesAsync()`
|
|
567
|
-
* method described below for async iteration which you can stop as needed.
|
|
568
|
-
* Please see the
|
|
569
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
570
|
-
* for more details and examples.
|
|
571
|
-
*/
|
|
572
|
-
listNotesStream(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): Transform;
|
|
573
|
-
/**
|
|
574
|
-
* Equivalent to `listNotes`, but returns an iterable object.
|
|
575
|
-
*
|
|
576
|
-
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
577
|
-
* @param {Object} request
|
|
578
|
-
* The request object that will be sent.
|
|
579
|
-
* @param {string} request.parent
|
|
580
|
-
* The name of the project to list notes for in the form of
|
|
581
|
-
* `projects/[PROJECT_ID]`.
|
|
582
|
-
* @param {string} request.filter
|
|
583
|
-
* The filter expression.
|
|
584
|
-
* @param {number} request.pageSize
|
|
585
|
-
* Number of notes to return in the list. Must be positive. Max allowed page
|
|
586
|
-
* size is 1000. If not specified, page size defaults to 20.
|
|
587
|
-
* @param {string} request.pageToken
|
|
588
|
-
* Token to provide to skip to a particular spot in the list.
|
|
589
|
-
* @param {object} [options]
|
|
590
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
591
|
-
* @returns {Object}
|
|
592
|
-
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
|
|
593
|
-
* When you iterate the returned iterable, each element will be an object representing
|
|
594
|
-
* [Note]{@link grafeas.v1.Note}. The API will be called under the hood as needed, once per the page,
|
|
595
|
-
* so you can stop the iteration when you don't need more results.
|
|
596
|
-
* Please see the
|
|
597
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
598
|
-
* for more details and examples.
|
|
599
|
-
* @example <caption>include:samples/generated/v1/grafeas.list_notes.js</caption>
|
|
600
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_ListNotes_async
|
|
601
|
-
*/
|
|
602
|
-
listNotesAsync(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.INote>;
|
|
603
|
-
/**
|
|
604
|
-
* Lists occurrences referencing the specified note. Provider projects can use
|
|
605
|
-
* this method to get all occurrences across consumer projects referencing the
|
|
606
|
-
* specified note.
|
|
607
|
-
*
|
|
608
|
-
* @param {Object} request
|
|
609
|
-
* The request object that will be sent.
|
|
610
|
-
* @param {string} request.name
|
|
611
|
-
* The name of the note to list occurrences for in the form of
|
|
612
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
613
|
-
* @param {string} request.filter
|
|
614
|
-
* The filter expression.
|
|
615
|
-
* @param {number} request.pageSize
|
|
616
|
-
* Number of occurrences to return in the list.
|
|
617
|
-
* @param {string} request.pageToken
|
|
618
|
-
* Token to provide to skip to a particular spot in the list.
|
|
619
|
-
* @param {object} [options]
|
|
620
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
621
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
622
|
-
* The first element of the array is Array of [Occurrence]{@link grafeas.v1.Occurrence}.
|
|
623
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
624
|
-
* times as needed and will merge results from all the pages into this array.
|
|
625
|
-
* Note that it can affect your quota.
|
|
626
|
-
* We recommend using `listNoteOccurrencesAsync()`
|
|
627
|
-
* method described below for async iteration which you can stop as needed.
|
|
628
|
-
* Please see the
|
|
629
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
630
|
-
* for more details and examples.
|
|
631
|
-
*/
|
|
632
|
-
listNoteOccurrences(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[
|
|
633
|
-
protos.grafeas.v1.IOccurrence[],
|
|
634
|
-
protos.grafeas.v1.IListNoteOccurrencesRequest | null,
|
|
635
|
-
protos.grafeas.v1.IListNoteOccurrencesResponse
|
|
636
|
-
]>;
|
|
637
|
-
listNoteOccurrences(request: protos.grafeas.v1.IListNoteOccurrencesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
|
|
638
|
-
listNoteOccurrences(request: protos.grafeas.v1.IListNoteOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
|
|
639
|
-
/**
|
|
640
|
-
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
641
|
-
* @param {Object} request
|
|
642
|
-
* The request object that will be sent.
|
|
643
|
-
* @param {string} request.name
|
|
644
|
-
* The name of the note to list occurrences for in the form of
|
|
645
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
646
|
-
* @param {string} request.filter
|
|
647
|
-
* The filter expression.
|
|
648
|
-
* @param {number} request.pageSize
|
|
649
|
-
* Number of occurrences to return in the list.
|
|
650
|
-
* @param {string} request.pageToken
|
|
651
|
-
* Token to provide to skip to a particular spot in the list.
|
|
652
|
-
* @param {object} [options]
|
|
653
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
654
|
-
* @returns {Stream}
|
|
655
|
-
* An object stream which emits an object representing [Occurrence]{@link grafeas.v1.Occurrence} on 'data' event.
|
|
656
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
657
|
-
* times as needed. Note that it can affect your quota.
|
|
658
|
-
* We recommend using `listNoteOccurrencesAsync()`
|
|
659
|
-
* method described below for async iteration which you can stop as needed.
|
|
660
|
-
* Please see the
|
|
661
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
662
|
-
* for more details and examples.
|
|
663
|
-
*/
|
|
664
|
-
listNoteOccurrencesStream(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): Transform;
|
|
665
|
-
/**
|
|
666
|
-
* Equivalent to `listNoteOccurrences`, but returns an iterable object.
|
|
667
|
-
*
|
|
668
|
-
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
669
|
-
* @param {Object} request
|
|
670
|
-
* The request object that will be sent.
|
|
671
|
-
* @param {string} request.name
|
|
672
|
-
* The name of the note to list occurrences for in the form of
|
|
673
|
-
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
|
|
674
|
-
* @param {string} request.filter
|
|
675
|
-
* The filter expression.
|
|
676
|
-
* @param {number} request.pageSize
|
|
677
|
-
* Number of occurrences to return in the list.
|
|
678
|
-
* @param {string} request.pageToken
|
|
679
|
-
* Token to provide to skip to a particular spot in the list.
|
|
680
|
-
* @param {object} [options]
|
|
681
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
682
|
-
* @returns {Object}
|
|
683
|
-
* An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
|
|
684
|
-
* When you iterate the returned iterable, each element will be an object representing
|
|
685
|
-
* [Occurrence]{@link grafeas.v1.Occurrence}. The API will be called under the hood as needed, once per the page,
|
|
686
|
-
* so you can stop the iteration when you don't need more results.
|
|
687
|
-
* Please see the
|
|
688
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
|
689
|
-
* for more details and examples.
|
|
690
|
-
* @example <caption>include:samples/generated/v1/grafeas.list_note_occurrences.js</caption>
|
|
691
|
-
* region_tag:containeranalysis_v1_generated_Grafeas_ListNoteOccurrences_async
|
|
692
|
-
*/
|
|
693
|
-
listNoteOccurrencesAsync(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.IOccurrence>;
|
|
694
|
-
/**
|
|
695
|
-
* Return a fully-qualified note resource name string.
|
|
696
|
-
*
|
|
697
|
-
* @param {string} project
|
|
698
|
-
* @param {string} note
|
|
699
|
-
* @returns {string} Resource name string.
|
|
700
|
-
*/
|
|
701
|
-
notePath(project: string, note: string): string;
|
|
702
|
-
/**
|
|
703
|
-
* Parse the project from Note resource.
|
|
704
|
-
*
|
|
705
|
-
* @param {string} noteName
|
|
706
|
-
* A fully-qualified path representing Note resource.
|
|
707
|
-
* @returns {string} A string representing the project.
|
|
708
|
-
*/
|
|
709
|
-
matchProjectFromNoteName(noteName: string): string | number;
|
|
710
|
-
/**
|
|
711
|
-
* Parse the note from Note resource.
|
|
712
|
-
*
|
|
713
|
-
* @param {string} noteName
|
|
714
|
-
* A fully-qualified path representing Note resource.
|
|
715
|
-
* @returns {string} A string representing the note.
|
|
716
|
-
*/
|
|
717
|
-
matchNoteFromNoteName(noteName: string): string | number;
|
|
718
|
-
/**
|
|
719
|
-
* Return a fully-qualified occurrence resource name string.
|
|
720
|
-
*
|
|
721
|
-
* @param {string} project
|
|
722
|
-
* @param {string} occurrence
|
|
723
|
-
* @returns {string} Resource name string.
|
|
724
|
-
*/
|
|
725
|
-
occurrencePath(project: string, occurrence: string): string;
|
|
726
|
-
/**
|
|
727
|
-
* Parse the project from Occurrence resource.
|
|
728
|
-
*
|
|
729
|
-
* @param {string} occurrenceName
|
|
730
|
-
* A fully-qualified path representing Occurrence resource.
|
|
731
|
-
* @returns {string} A string representing the project.
|
|
732
|
-
*/
|
|
733
|
-
matchProjectFromOccurrenceName(occurrenceName: string): string | number;
|
|
734
|
-
/**
|
|
735
|
-
* Parse the occurrence from Occurrence resource.
|
|
736
|
-
*
|
|
737
|
-
* @param {string} occurrenceName
|
|
738
|
-
* A fully-qualified path representing Occurrence resource.
|
|
739
|
-
* @returns {string} A string representing the occurrence.
|
|
740
|
-
*/
|
|
741
|
-
matchOccurrenceFromOccurrenceName(occurrenceName: string): string | number;
|
|
742
|
-
/**
|
|
743
|
-
* Return a fully-qualified project resource name string.
|
|
744
|
-
*
|
|
745
|
-
* @param {string} project
|
|
746
|
-
* @returns {string} Resource name string.
|
|
747
|
-
*/
|
|
748
|
-
projectPath(project: string): string;
|
|
749
|
-
/**
|
|
750
|
-
* Parse the project from Project resource.
|
|
751
|
-
*
|
|
752
|
-
* @param {string} projectName
|
|
753
|
-
* A fully-qualified path representing Project resource.
|
|
754
|
-
* @returns {string} A string representing the project.
|
|
755
|
-
*/
|
|
756
|
-
matchProjectFromProjectName(projectName: string): string | number;
|
|
757
|
-
/**
|
|
758
|
-
* Terminate the gRPC channel and close the client.
|
|
759
|
-
*
|
|
760
|
-
* The client will no longer be usable and all future behavior is undefined.
|
|
761
|
-
* @returns {Promise} A promise that resolves when the client is closed.
|
|
762
|
-
*/
|
|
763
|
-
close(): Promise<void>;
|
|
764
|
-
}
|