Class v1.GrafeasClient (3.4.6)

[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. v1

Package

@google-cloud/grafeas!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of GrafeasClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

grafeasStub

grafeasStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

innerApiCalls

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

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): never[];

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

Property Value
TypeDescription
never[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

warn

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

Methods

batchCreateNotes(request, options)

batchCreateNotes(request?: protos.grafeas.v1.IBatchCreateNotesRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateNotesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | undefined, {} | undefined]>

batchCreateNotes(request, options, callback)

batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateNotesRequest
options CallOptions
callback Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchCreateNotes(request, callback)

batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateNotesRequest
callback Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchCreateOccurrences(request, options)

batchCreateOccurrences(request?: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateOccurrencesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | undefined, {} | undefined]>

batchCreateOccurrences(request, options, callback)

batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateOccurrencesRequest
options CallOptions
callback Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

batchCreateOccurrences(request, callback)

batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IBatchCreateOccurrencesRequest
callback Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
Promise<void>

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

createNote(request, options)

createNote(request?: protos.grafeas.v1.ICreateNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.ICreateNoteRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | undefined, {} | undefined]>

createNote(request, options, callback)

createNote(request: protos.grafeas.v1.ICreateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.ICreateNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNote(request, callback)

createNote(request: protos.grafeas.v1.ICreateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.ICreateNoteRequest
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createOccurrence(request, options)

createOccurrence(request?: protos.grafeas.v1.ICreateOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.ICreateOccurrenceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | undefined, {} | undefined]>

createOccurrence(request, options, callback)

createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.ICreateOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createOccurrence(request, callback)

createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.ICreateOccurrenceRequest
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNote(request, options)

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

deleteNote(request, options, callback)

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

deleteNote(request, callback)

deleteNote(request: protos.grafeas.v1.IDeleteNoteRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IDeleteNoteRequest
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOccurrence(request, options)

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

deleteOccurrence(request, options, callback)

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

deleteOccurrence(request, callback)

deleteOccurrence(request: protos.grafeas.v1.IDeleteOccurrenceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IDeleteOccurrenceRequest
callback Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNote(request, options)

getNote(request?: protos.grafeas.v1.IGetNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IGetNoteRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | undefined, {} | undefined]>

getNote(request, options, callback)

getNote(request: protos.grafeas.v1.IGetNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNote(request, callback)

getNote(request: protos.grafeas.v1.IGetNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetNoteRequest
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getOccurrence(request, options)

getOccurrence(request?: protos.grafeas.v1.IGetOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | undefined, {} | undefined]>

getOccurrence(request, options, callback)

getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getOccurrence(request, callback)

getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceRequest
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getOccurrenceNote(request, options)

getOccurrenceNote(request?: protos.grafeas.v1.IGetOccurrenceNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceNoteRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | undefined, {} | undefined]>

getOccurrenceNote(request, options, callback)

getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getOccurrenceNote(request, callback)

getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IGetOccurrenceNoteRequest
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

listNoteOccurrences(request, options)

listNoteOccurrences(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IOccurrence[], protos.grafeas.v1.IListNoteOccurrencesRequest | null, protos.grafeas.v1.IListNoteOccurrencesResponse]>;
Parameters
NameDescription
request protos.grafeas.v1.IListNoteOccurrencesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IOccurrence[], protos.grafeas.v1.IListNoteOccurrencesRequest | null, protos.grafeas.v1.IListNoteOccurrencesResponse]>

listNoteOccurrences(request, options, callback)

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;
Parameters
NameDescription
request protos.grafeas.v1.IListNoteOccurrencesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>
Returns
TypeDescription
void

listNoteOccurrences(request, callback)

listNoteOccurrences(request: protos.grafeas.v1.IListNoteOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
Parameters
NameDescription
request protos.grafeas.v1.IListNoteOccurrencesRequest
callback PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>
Returns
TypeDescription
void

listNoteOccurrencesAsync(request, options)

listNoteOccurrencesAsync(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.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
NameDescription
request protos.grafeas.v1.IListNoteOccurrencesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.grafeas.v1.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.

listNoteOccurrencesStream(request, options)

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

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

Parameters
NameDescription
request protos.grafeas.v1.IListNoteOccurrencesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1.IListNotesRequest, options?: CallOptions): Promise<[protos.grafeas.v1.INote[], protos.grafeas.v1.IListNotesRequest | null, protos.grafeas.v1.IListNotesResponse]>;
Parameters
NameDescription
request protos.grafeas.v1.IListNotesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.INote[], protos.grafeas.v1.IListNotesRequest | null, protos.grafeas.v1.IListNotesResponse]>

listNotes(request, options, callback)

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;
Parameters
NameDescription
request protos.grafeas.v1.IListNotesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>
Returns
TypeDescription
void

listNotes(request, callback)

listNotes(request: protos.grafeas.v1.IListNotesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>): void;
Parameters
NameDescription
request protos.grafeas.v1.IListNotesRequest
callback PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>
Returns
TypeDescription
void

listNotesAsync(request, options)

listNotesAsync(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.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
NameDescription
request protos.grafeas.v1.IListNotesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.grafeas.v1.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.

listNotesStream(request, options)

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

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

Parameters
NameDescription
request protos.grafeas.v1.IListNotesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1.IListOccurrencesRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IOccurrence[], protos.grafeas.v1.IListOccurrencesRequest | null, protos.grafeas.v1.IListOccurrencesResponse]>;
Parameters
NameDescription
request protos.grafeas.v1.IListOccurrencesRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IOccurrence[], protos.grafeas.v1.IListOccurrencesRequest | null, protos.grafeas.v1.IListOccurrencesResponse]>

listOccurrences(request, options, callback)

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;
Parameters
NameDescription
request protos.grafeas.v1.IListOccurrencesRequest
options CallOptions
callback PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>
Returns
TypeDescription
void

listOccurrences(request, callback)

listOccurrences(request: protos.grafeas.v1.IListOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
Parameters
NameDescription
request protos.grafeas.v1.IListOccurrencesRequest
callback PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>
Returns
TypeDescription
void

listOccurrencesAsync(request, options)

listOccurrencesAsync(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.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
NameDescription
request protos.grafeas.v1.IListOccurrencesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.grafeas.v1.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.

listOccurrencesStream(request, options)

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

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

Parameters
NameDescription
request protos.grafeas.v1.IListOccurrencesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

matchNoteFromNoteName(noteName)

matchNoteFromNoteName(noteName: string): string | number;

Parse the note from Note resource.

Parameter
NameDescription
noteName string

A fully-qualified path representing Note resource.

Returns
TypeDescription
string | number

{string} A string representing the note.

matchOccurrenceFromOccurrenceName(occurrenceName)

matchOccurrenceFromOccurrenceName(occurrenceName: string): string | number;

Parse the occurrence from Occurrence resource.

Parameter
NameDescription
occurrenceName string

A fully-qualified path representing Occurrence resource.

Returns
TypeDescription
string | number

{string} A string representing the occurrence.

matchProjectFromNoteName(noteName)

matchProjectFromNoteName(noteName: string): string | number;

Parse the project from Note resource.

Parameter
NameDescription
noteName string

A fully-qualified path representing Note resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromOccurrenceName(occurrenceName)

matchProjectFromOccurrenceName(occurrenceName: string): string | number;

Parse the project from Occurrence resource.

Parameter
NameDescription
occurrenceName string

A fully-qualified path representing Occurrence resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

notePath(project, note)

notePath(project: string, note: string): string;

Return a fully-qualified note resource name string.

Parameters
NameDescription
project string
note string
Returns
TypeDescription
string

{string} Resource name string.

occurrencePath(project, occurrence)

occurrencePath(project: string, occurrence: string): string;

Return a fully-qualified occurrence resource name string.

Parameters
NameDescription
project string
occurrence string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

updateNote(request, options)

updateNote(request?: protos.grafeas.v1.IUpdateNoteRequest, options?: CallOptions): Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateNoteRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | undefined, {} | undefined]>

updateNote(request, options, callback)

updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateNoteRequest
options CallOptions
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateNote(request, callback)

updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateNoteRequest
callback Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateOccurrence(request, options)

updateOccurrence(request?: protos.grafeas.v1.IUpdateOccurrenceRequest, options?: CallOptions): Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateOccurrenceRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | undefined, {} | undefined]>

updateOccurrence(request, options, callback)

updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateOccurrenceRequest
options CallOptions
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateOccurrence(request, callback)

updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.grafeas.v1.IUpdateOccurrenceRequest
callback Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void