Class v1beta1.GrafeasV1Beta1Client (3.2.0)

[Grafeas](https://grafeas.io) API.

Retrieves analysis results of Cloud components such as Docker container images.

Analysis results are stored as a series of occurrences. An Occurrence contains information about a specific analysis instance on a resource. An occurrence refers to a Note. A note contains details describing the analysis and is generally stored in a separate project, called a Provider. Multiple occurrences can refer to the same note.

For example, an SSL vulnerability could affect multiple images. In this case, there would be one note for the vulnerability and an occurrence for each image with the vulnerability referring to that note. v1beta1

Package

@google-cloud/containeranalysis

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of GrafeasV1Beta1Client.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

grafeasV1Beta1Stub

grafeasV1Beta1Stub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

batchCreateNotes(request, options)

batchCreateNotes(request?: protos.grafeas.v1beta1.IBatchCreateNotesRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateNotesRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | undefined, {} | undefined]>

batchCreateNotes(request, options, callback)

batchCreateNotes(request: protos.grafeas.v1beta1.IBatchCreateNotesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateNotesRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

batchCreateNotes(request, callback)

batchCreateNotes(request: protos.grafeas.v1beta1.IBatchCreateNotesRequest, callback: Callback<protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateNotesRequest
callback Callback<protos.grafeas.v1beta1.IBatchCreateNotesResponse, protos.grafeas.v1beta1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

batchCreateOccurrences(request, options)

batchCreateOccurrences(request?: protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | undefined, {} | undefined]>

batchCreateOccurrences(request, options, callback)

batchCreateOccurrences(request: protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

batchCreateOccurrences(request, callback)

batchCreateOccurrences(request: protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest, callback: Callback<protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest
callback Callback<protos.grafeas.v1beta1.IBatchCreateOccurrencesResponse, protos.grafeas.v1beta1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createNote(request, options)

createNote(request?: protos.grafeas.v1beta1.ICreateNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateNoteRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | undefined, {} | undefined]>

createNote(request, options, callback)

createNote(request: protos.grafeas.v1beta1.ICreateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createNote(request, callback)

createNote(request: protos.grafeas.v1beta1.ICreateNoteRequest, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateNoteRequest
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.ICreateNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createOccurrence(request, options)

createOccurrence(request?: protos.grafeas.v1beta1.ICreateOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateOccurrenceRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | undefined, {} | undefined]>

createOccurrence(request, options, callback)

createOccurrence(request: protos.grafeas.v1beta1.ICreateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createOccurrence(request, callback)

createOccurrence(request: protos.grafeas.v1beta1.ICreateOccurrenceRequest, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.ICreateOccurrenceRequest
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteNote(request, options)

deleteNote(request?: protos.grafeas.v1beta1.IDeleteNoteRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteNoteRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | undefined, {} | undefined]>

deleteNote(request, options, callback)

deleteNote(request: protos.grafeas.v1beta1.IDeleteNoteRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteNoteRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteNote(request, callback)

deleteNote(request: protos.grafeas.v1beta1.IDeleteNoteRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteNoteRequest
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOccurrence(request, options)

deleteOccurrence(request?: protos.grafeas.v1beta1.IDeleteOccurrenceRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteOccurrenceRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | undefined, {} | undefined]>

deleteOccurrence(request, options, callback)

deleteOccurrence(request: protos.grafeas.v1beta1.IDeleteOccurrenceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteOccurrenceRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOccurrence(request, callback)

deleteOccurrence(request: protos.grafeas.v1beta1.IDeleteOccurrenceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IDeleteOccurrenceRequest
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1beta1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getNote(request, options)

getNote(request?: protos.grafeas.v1beta1.IGetNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetNoteRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | undefined, {} | undefined]>

getNote(request, options, callback)

getNote(request: protos.grafeas.v1beta1.IGetNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getNote(request, callback)

getNote(request: protos.grafeas.v1beta1.IGetNoteRequest, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetNoteRequest
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOccurrence(request, options)

getOccurrence(request?: protos.grafeas.v1beta1.IGetOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | undefined, {} | undefined]>

getOccurrence(request, options, callback)

getOccurrence(request: protos.grafeas.v1beta1.IGetOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOccurrence(request, callback)

getOccurrence(request: protos.grafeas.v1beta1.IGetOccurrenceRequest, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceRequest
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOccurrenceNote(request, options)

getOccurrenceNote(request?: protos.grafeas.v1beta1.IGetOccurrenceNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceNoteRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | undefined, {} | undefined]>

getOccurrenceNote(request, options, callback)

getOccurrenceNote(request: protos.grafeas.v1beta1.IGetOccurrenceNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOccurrenceNote(request, callback)

getOccurrenceNote(request: protos.grafeas.v1beta1.IGetOccurrenceNoteRequest, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetOccurrenceNoteRequest
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getVulnerabilityOccurrencesSummary(request, options)

getVulnerabilityOccurrencesSummary(request?: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, (protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, (protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | undefined), {} | undefined]>

getVulnerabilityOccurrencesSummary(request, options, callback)

getVulnerabilityOccurrencesSummary(request: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getVulnerabilityOccurrencesSummary(request, callback)

getVulnerabilityOccurrencesSummary(request: protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest, callback: Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest
callback Callback<protos.grafeas.v1beta1.IVulnerabilityOccurrencesSummary, protos.grafeas.v1beta1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listNoteOccurrences(request, options)

listNoteOccurrences(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IOccurrence[], protos.grafeas.v1beta1.IListNoteOccurrencesRequest | null, protos.grafeas.v1beta1.IListNoteOccurrencesResponse]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNoteOccurrencesRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IOccurrence[], protos.grafeas.v1beta1.IListNoteOccurrencesRequest | null, protos.grafeas.v1beta1.IListNoteOccurrencesResponse]>

listNoteOccurrences(request, options, callback)

listNoteOccurrences(request: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1beta1.IListNoteOccurrencesRequest, protos.grafeas.v1beta1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNoteOccurrencesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1beta1.IListNoteOccurrencesRequest, protos.grafeas.v1beta1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>
Returns
Type Description
void

listNoteOccurrences(request, callback)

listNoteOccurrences(request: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1beta1.IListNoteOccurrencesRequest, protos.grafeas.v1beta1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNoteOccurrencesRequest
callback PaginationCallback<protos.grafeas.v1beta1.IListNoteOccurrencesRequest, protos.grafeas.v1beta1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>
Returns
Type Description
void

listNoteOccurrencesAsync(request, options)

listNoteOccurrencesAsync(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1beta1.IOccurrence>;

Equivalent to listNoteOccurrences, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.grafeas.v1beta1.IListNoteOccurrencesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.grafeas.v1beta1.IOccurrence>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Occurrence]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example

const iterable = client.listNoteOccurrencesAsync(request); for await (const response of iterable) { // process response }

listNoteOccurrencesStream(request, options)

listNoteOccurrencesStream(request?: protos.grafeas.v1beta1.IListNoteOccurrencesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.grafeas.v1beta1.IListNoteOccurrencesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Occurrence] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNoteOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listNotes(request, options)

listNotes(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.INote[], protos.grafeas.v1beta1.IListNotesRequest | null, protos.grafeas.v1beta1.IListNotesResponse]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNotesRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.INote[], protos.grafeas.v1beta1.IListNotesRequest | null, protos.grafeas.v1beta1.IListNotesResponse]>

listNotes(request, options, callback)

listNotes(request: protos.grafeas.v1beta1.IListNotesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1beta1.IListNotesRequest, protos.grafeas.v1beta1.IListNotesResponse | null | undefined, protos.grafeas.v1beta1.INote>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNotesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1beta1.IListNotesRequest, protos.grafeas.v1beta1.IListNotesResponse | null | undefined, protos.grafeas.v1beta1.INote>
Returns
Type Description
void

listNotes(request, callback)

listNotes(request: protos.grafeas.v1beta1.IListNotesRequest, callback: PaginationCallback<protos.grafeas.v1beta1.IListNotesRequest, protos.grafeas.v1beta1.IListNotesResponse | null | undefined, protos.grafeas.v1beta1.INote>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListNotesRequest
callback PaginationCallback<protos.grafeas.v1beta1.IListNotesRequest, protos.grafeas.v1beta1.IListNotesResponse | null | undefined, protos.grafeas.v1beta1.INote>
Returns
Type Description
void

listNotesAsync(request, options)

listNotesAsync(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1beta1.INote>;

Equivalent to listNotes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.grafeas.v1beta1.IListNotesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.grafeas.v1beta1.INote>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Note]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example

const iterable = client.listNotesAsync(request); for await (const response of iterable) { // process response }

listNotesStream(request, options)

listNotesStream(request?: protos.grafeas.v1beta1.IListNotesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.grafeas.v1beta1.IListNotesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Note] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNotesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listOccurrences(request, options)

listOccurrences(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IOccurrence[], protos.grafeas.v1beta1.IListOccurrencesRequest | null, protos.grafeas.v1beta1.IListOccurrencesResponse]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IListOccurrencesRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IOccurrence[], protos.grafeas.v1beta1.IListOccurrencesRequest | null, protos.grafeas.v1beta1.IListOccurrencesResponse]>

listOccurrences(request, options, callback)

listOccurrences(request: protos.grafeas.v1beta1.IListOccurrencesRequest, options: CallOptions, callback: PaginationCallback<protos.grafeas.v1beta1.IListOccurrencesRequest, protos.grafeas.v1beta1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListOccurrencesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1beta1.IListOccurrencesRequest, protos.grafeas.v1beta1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>
Returns
Type Description
void

listOccurrences(request, callback)

listOccurrences(request: protos.grafeas.v1beta1.IListOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1beta1.IListOccurrencesRequest, protos.grafeas.v1beta1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IListOccurrencesRequest
callback PaginationCallback<protos.grafeas.v1beta1.IListOccurrencesRequest, protos.grafeas.v1beta1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1beta1.IOccurrence>
Returns
Type Description
void

listOccurrencesAsync(request, options)

listOccurrencesAsync(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1beta1.IOccurrence>;

Equivalent to listOccurrences, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.grafeas.v1beta1.IListOccurrencesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.grafeas.v1beta1.IOccurrence>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Occurrence]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
Example

const iterable = client.listOccurrencesAsync(request); for await (const response of iterable) { // process response }

listOccurrencesStream(request, options)

listOccurrencesStream(request?: protos.grafeas.v1beta1.IListOccurrencesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.grafeas.v1beta1.IListOccurrencesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Occurrence] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchProjectFromScanConfigName(scanConfigName)

matchProjectFromScanConfigName(scanConfigName: string): string | number;

Parse the project from ScanConfig resource.

Parameter
Name Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchScanConfigFromScanConfigName(scanConfigName)

matchScanConfigFromScanConfigName(scanConfigName: string): string | number;

Parse the scan_config from ScanConfig resource.

Parameter
Name Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns
Type Description
string | number

{string} A string representing the scan_config.

scanConfigPath(project, scanConfig)

scanConfigPath(project: string, scanConfig: string): string;

Return a fully-qualified scanConfig resource name string.

Parameters
Name Description
project string
scanConfig string
Returns
Type Description
string

{string} Resource name string.

updateNote(request, options)

updateNote(request?: protos.grafeas.v1beta1.IUpdateNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateNoteRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | undefined, {} | undefined]>

updateNote(request, options, callback)

updateNote(request: protos.grafeas.v1beta1.IUpdateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateNote(request, callback)

updateNote(request: protos.grafeas.v1beta1.IUpdateNoteRequest, callback: Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateNoteRequest
callback Callback<protos.grafeas.v1beta1.INote, protos.grafeas.v1beta1.IUpdateNoteRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateOccurrence(request, options)

updateOccurrence(request?: protos.grafeas.v1beta1.IUpdateOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateOccurrenceRequest
options CallOptions
Returns
Type Description
Promise<[protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | undefined, {} | undefined]>

updateOccurrence(request, options, callback)

updateOccurrence(request: protos.grafeas.v1beta1.IUpdateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateOccurrence(request, callback)

updateOccurrence(request: protos.grafeas.v1beta1.IUpdateOccurrenceRequest, callback: Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.grafeas.v1beta1.IUpdateOccurrenceRequest
callback Callback<protos.grafeas.v1beta1.IOccurrence, protos.grafeas.v1beta1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void