@google-cloud/containeranalysis 4.4.0 → 4.4.2

package/build/src/v1/grafeas_client.d.ts

@@ -0,0 +1,764 @@
+/// <reference types="node" />
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  [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.
+ * @class
+ * @memberof v1
+ */
+export declare class GrafeasClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    grafeasStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of GrafeasClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
+     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new GrafeasClient({fallback: 'rest'}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * 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 {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath(),
+     * exists for compatibility reasons.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): never[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Gets the specified occurrence.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the occurrence in the form of
+     *   `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.get_occurrence.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_GetOccurrence_async
+     */
+    getOccurrence(request?: protos.grafeas.v1.IGetOccurrenceRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IOccurrence,
+        protos.grafeas.v1.IGetOccurrenceRequest | undefined,
+        {} | undefined
+    ]>;
+    getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    getOccurrence(request: protos.grafeas.v1.IGetOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IGetOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes the specified occurrence. For example, use this method to delete an
+     * occurrence when the occurrence is no longer applicable for the given
+     * resource.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the occurrence in the form of
+     *   `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.delete_occurrence.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_DeleteOccurrence_async
+     */
+    deleteOccurrence(request?: protos.grafeas.v1.IDeleteOccurrenceRequest, options?: CallOptions): Promise<[
+        protos.google.protobuf.IEmpty,
+        protos.grafeas.v1.IDeleteOccurrenceRequest | undefined,
+        {} | undefined
+    ]>;
+    deleteOccurrence(request: protos.grafeas.v1.IDeleteOccurrenceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    deleteOccurrence(request: protos.grafeas.v1.IDeleteOccurrenceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates a new occurrence.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project in the form of `projects/[PROJECT_ID]`, under which
+     *   the occurrence is to be created.
+     * @param {grafeas.v1.Occurrence} request.occurrence
+     *   The occurrence to create.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.create_occurrence.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_CreateOccurrence_async
+     */
+    createOccurrence(request?: protos.grafeas.v1.ICreateOccurrenceRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IOccurrence,
+        protos.grafeas.v1.ICreateOccurrenceRequest | undefined,
+        {} | undefined
+    ]>;
+    createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    createOccurrence(request: protos.grafeas.v1.ICreateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.ICreateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates new occurrences in batch.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project in the form of `projects/[PROJECT_ID]`, under which
+     *   the occurrences are to be created.
+     * @param {number[]} request.occurrences
+     *   The occurrences to create. Max allowed length is 1000.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [BatchCreateOccurrencesResponse]{@link grafeas.v1.BatchCreateOccurrencesResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.batch_create_occurrences.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_BatchCreateOccurrences_async
+     */
+    batchCreateOccurrences(request?: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IBatchCreateOccurrencesResponse,
+        protos.grafeas.v1.IBatchCreateOccurrencesRequest | undefined,
+        {} | undefined
+    ]>;
+    batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
+    batchCreateOccurrences(request: protos.grafeas.v1.IBatchCreateOccurrencesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateOccurrencesResponse, protos.grafeas.v1.IBatchCreateOccurrencesRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates the specified occurrence.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the occurrence in the form of
+     *   `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+     * @param {grafeas.v1.Occurrence} request.occurrence
+     *   The updated occurrence.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   The fields to update.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Occurrence]{@link grafeas.v1.Occurrence}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.update_occurrence.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_UpdateOccurrence_async
+     */
+    updateOccurrence(request?: protos.grafeas.v1.IUpdateOccurrenceRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IOccurrence,
+        protos.grafeas.v1.IUpdateOccurrenceRequest | undefined,
+        {} | undefined
+    ]>;
+    updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    updateOccurrence(request: protos.grafeas.v1.IUpdateOccurrenceRequest, callback: Callback<protos.grafeas.v1.IOccurrence, protos.grafeas.v1.IUpdateOccurrenceRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the note attached to the specified occurrence. Consumer projects can
+     * use this method to get a note that belongs to a provider project.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the occurrence in the form of
+     *   `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.get_occurrence_note.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_GetOccurrenceNote_async
+     */
+    getOccurrenceNote(request?: protos.grafeas.v1.IGetOccurrenceNoteRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.INote,
+        protos.grafeas.v1.IGetOccurrenceNoteRequest | undefined,
+        {} | undefined
+    ]>;
+    getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
+    getOccurrenceNote(request: protos.grafeas.v1.IGetOccurrenceNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetOccurrenceNoteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the specified note.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.get_note.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_GetNote_async
+     */
+    getNote(request?: protos.grafeas.v1.IGetNoteRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.INote,
+        protos.grafeas.v1.IGetNoteRequest | undefined,
+        {} | undefined
+    ]>;
+    getNote(request: protos.grafeas.v1.IGetNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
+    getNote(request: protos.grafeas.v1.IGetNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IGetNoteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes the specified note.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Empty]{@link google.protobuf.Empty}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.delete_note.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_DeleteNote_async
+     */
+    deleteNote(request?: protos.grafeas.v1.IDeleteNoteRequest, options?: CallOptions): Promise<[
+        protos.google.protobuf.IEmpty,
+        protos.grafeas.v1.IDeleteNoteRequest | undefined,
+        {} | undefined
+    ]>;
+    deleteNote(request: protos.grafeas.v1.IDeleteNoteRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
+    deleteNote(request: protos.grafeas.v1.IDeleteNoteRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.grafeas.v1.IDeleteNoteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates a new note.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project in the form of `projects/[PROJECT_ID]`, under which
+     *   the note is to be created.
+     * @param {string} request.noteId
+     *   The ID to use for this note.
+     * @param {grafeas.v1.Note} request.note
+     *   The note to create.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.create_note.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_CreateNote_async
+     */
+    createNote(request?: protos.grafeas.v1.ICreateNoteRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.INote,
+        protos.grafeas.v1.ICreateNoteRequest | undefined,
+        {} | undefined
+    ]>;
+    createNote(request: protos.grafeas.v1.ICreateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
+    createNote(request: protos.grafeas.v1.ICreateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.ICreateNoteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates new notes in batch.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project in the form of `projects/[PROJECT_ID]`, under which
+     *   the notes are to be created.
+     * @param {number[]} request.notes
+     *   The notes to create. Max allowed length is 1000.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [BatchCreateNotesResponse]{@link grafeas.v1.BatchCreateNotesResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.batch_create_notes.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_BatchCreateNotes_async
+     */
+    batchCreateNotes(request?: protos.grafeas.v1.IBatchCreateNotesRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IBatchCreateNotesResponse,
+        protos.grafeas.v1.IBatchCreateNotesRequest | undefined,
+        {} | undefined
+    ]>;
+    batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
+    batchCreateNotes(request: protos.grafeas.v1.IBatchCreateNotesRequest, callback: Callback<protos.grafeas.v1.IBatchCreateNotesResponse, protos.grafeas.v1.IBatchCreateNotesRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates the specified note.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {grafeas.v1.Note} request.note
+     *   The updated note.
+     * @param {google.protobuf.FieldMask} request.updateMask
+     *   The fields to update.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing [Note]{@link grafeas.v1.Note}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/grafeas.update_note.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_UpdateNote_async
+     */
+    updateNote(request?: protos.grafeas.v1.IUpdateNoteRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.INote,
+        protos.grafeas.v1.IUpdateNoteRequest | undefined,
+        {} | undefined
+    ]>;
+    updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, options: CallOptions, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
+    updateNote(request: protos.grafeas.v1.IUpdateNoteRequest, callback: Callback<protos.grafeas.v1.INote, protos.grafeas.v1.IUpdateNoteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Lists occurrences for the specified project.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list occurrences for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list. Must be positive. Max allowed
+     *   page size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of [Occurrence]{@link grafeas.v1.Occurrence}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   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.
+     */
+    listOccurrences(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IOccurrence[],
+        protos.grafeas.v1.IListOccurrencesRequest | null,
+        protos.grafeas.v1.IListOccurrencesResponse
+    ]>;
+    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;
+    listOccurrences(request: protos.grafeas.v1.IListOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListOccurrencesRequest, protos.grafeas.v1.IListOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list occurrences for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list. Must be positive. Max allowed
+     *   page size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [Occurrence]{@link grafeas.v1.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.
+     */
+    listOccurrencesStream(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listOccurrences`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list occurrences for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list. Must be positive. Max allowed
+     *   page size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {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]{@link grafeas.v1.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 <caption>include:samples/generated/v1/grafeas.list_occurrences.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_ListOccurrences_async
+     */
+    listOccurrencesAsync(request?: protos.grafeas.v1.IListOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.IOccurrence>;
+    /**
+     * Lists notes for the specified project.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list notes for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of notes to return in the list. Must be positive. Max allowed page
+     *   size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of [Note]{@link grafeas.v1.Note}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   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.
+     */
+    listNotes(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.INote[],
+        protos.grafeas.v1.IListNotesRequest | null,
+        protos.grafeas.v1.IListNotesResponse
+    ]>;
+    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;
+    listNotes(request: protos.grafeas.v1.IListNotesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNotesRequest, protos.grafeas.v1.IListNotesResponse | null | undefined, protos.grafeas.v1.INote>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list notes for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of notes to return in the list. Must be positive. Max allowed page
+     *   size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [Note]{@link grafeas.v1.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.
+     */
+    listNotesStream(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listNotes`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   The name of the project to list notes for in the form of
+     *   `projects/[PROJECT_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of notes to return in the list. Must be positive. Max allowed page
+     *   size is 1000. If not specified, page size defaults to 20.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {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]{@link grafeas.v1.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 <caption>include:samples/generated/v1/grafeas.list_notes.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_ListNotes_async
+     */
+    listNotesAsync(request?: protos.grafeas.v1.IListNotesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.INote>;
+    /**
+     * Lists occurrences referencing the specified note. Provider projects can use
+     * this method to get all occurrences across consumer projects referencing the
+     * specified note.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note to list occurrences for in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is Array of [Occurrence]{@link grafeas.v1.Occurrence}.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed and will merge results from all the pages into this array.
+     *   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.
+     */
+    listNoteOccurrences(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): Promise<[
+        protos.grafeas.v1.IOccurrence[],
+        protos.grafeas.v1.IListNoteOccurrencesRequest | null,
+        protos.grafeas.v1.IListNoteOccurrencesResponse
+    ]>;
+    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;
+    listNoteOccurrences(request: protos.grafeas.v1.IListNoteOccurrencesRequest, callback: PaginationCallback<protos.grafeas.v1.IListNoteOccurrencesRequest, protos.grafeas.v1.IListNoteOccurrencesResponse | null | undefined, protos.grafeas.v1.IOccurrence>): void;
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note to list occurrences for in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing [Occurrence]{@link grafeas.v1.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.
+     */
+    listNoteOccurrencesStream(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listNoteOccurrences`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   The name of the note to list occurrences for in the form of
+     *   `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
+     * @param {string} request.filter
+     *   The filter expression.
+     * @param {number} request.pageSize
+     *   Number of occurrences to return in the list.
+     * @param {string} request.pageToken
+     *   Token to provide to skip to a particular spot in the list.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {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]{@link grafeas.v1.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 <caption>include:samples/generated/v1/grafeas.list_note_occurrences.js</caption>
+     * region_tag:containeranalysis_v1_generated_Grafeas_ListNoteOccurrences_async
+     */
+    listNoteOccurrencesAsync(request?: protos.grafeas.v1.IListNoteOccurrencesRequest, options?: CallOptions): AsyncIterable<protos.grafeas.v1.IOccurrence>;
+    /**
+     * Return a fully-qualified note resource name string.
+     *
+     * @param {string} project
+     * @param {string} note
+     * @returns {string} Resource name string.
+     */
+    notePath(project: string, note: string): string;
+    /**
+     * Parse the project from Note resource.
+     *
+     * @param {string} noteName
+     *   A fully-qualified path representing Note resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromNoteName(noteName: string): string | number;
+    /**
+     * Parse the note from Note resource.
+     *
+     * @param {string} noteName
+     *   A fully-qualified path representing Note resource.
+     * @returns {string} A string representing the note.
+     */
+    matchNoteFromNoteName(noteName: string): string | number;
+    /**
+     * Return a fully-qualified occurrence resource name string.
+     *
+     * @param {string} project
+     * @param {string} occurrence
+     * @returns {string} Resource name string.
+     */
+    occurrencePath(project: string, occurrence: string): string;
+    /**
+     * Parse the project from Occurrence resource.
+     *
+     * @param {string} occurrenceName
+     *   A fully-qualified path representing Occurrence resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromOccurrenceName(occurrenceName: string): string | number;
+    /**
+     * Parse the occurrence from Occurrence resource.
+     *
+     * @param {string} occurrenceName
+     *   A fully-qualified path representing Occurrence resource.
+     * @returns {string} A string representing the occurrence.
+     */
+    matchOccurrenceFromOccurrenceName(occurrenceName: string): string | number;
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project: string): string;
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}