@google-cloud/containeranalysis

import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax'; import * as protos from '../../protos/protos'; /** * Retrieves analysis results of Cloud components such as Docker container * images. The Container Analysis API is an implementation of the * [Grafeas](https://grafeas.io) API. * * 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 ContainerAnalysisClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; containerAnalysisStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ContainerAnalysisClient. * * @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://cloud.google.com/docs/authentication/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} [options.fallback] - Use HTTP/1.1 REST mode. * 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 ContainerAnalysisClient({fallback: true}, 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. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): 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(): string[]; getProjectId(): Promise<string>; getProjectId(callback: Callback<string, undefined, undefined>): void; /** * Sets the access control policy on the specified note or occurrence. * Requires `containeranalysis.notes.setIamPolicy` or * `containeranalysis.occurrences.setIamPolicy` permission if the resource is * a note or an occurrence, respectively. * * The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for * notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for * occurrences. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being specified. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.Policy} request.policy * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a * valid policy but certain Cloud Platform services (such as Projects) * might reject them. * @param {google.protobuf.FieldMask} request.updateMask * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only * the fields in the mask will be modified. If no mask is provided, the * following default mask is used: * * `paths: "bindings, etag"` * @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 {@link protos.google.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/container_analysis.set_iam_policy.js</caption> * region_tag:containeranalysis_v1_generated_ContainerAnalysis_SetIamPolicy_async */ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Gets the access control policy for a note or an occurrence resource. * Requires `containeranalysis.notes.setIamPolicy` or * `containeranalysis.occurrences.setIamPolicy` permission if the resource is * a note or occurrence, respectively. * * The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for * notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for * occurrences. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.GetPolicyOptions} request.options * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. * @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 {@link protos.google.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/container_analysis.get_iam_policy.js</caption> * region_tag:containeranalysis_v1_generated_ContainerAnalysis_GetIamPolicy_async */ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void; /** * Returns the permissions that a caller has on the specified note or * occurrence. Requires list permission on the project (for example, * `containeranalysis.notes.list`). * * The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for * notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for * occurrences. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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 {@link protos.google.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/container_analysis.test_iam_permissions.js</caption> * region_tag:containeranalysis_v1_generated_ContainerAnalysis_TestIamPermissions_async */ testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void; /** * Gets a summary of the number and severity of occurrences. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The name of the project to get a vulnerability summary for in the * form of `projects/[PROJECT_ID]`. * @param {string} request.filter * The filter expression. * @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 {@link protos.google.devtools.containeranalysis.v1.VulnerabilityOccurrencesSummary|VulnerabilityOccurrencesSummary}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/container_analysis.get_vulnerability_occurrences_summary.js</caption> * region_tag:containeranalysis_v1_generated_ContainerAnalysis_GetVulnerabilityOccurrencesSummary_async */ getVulnerabilityOccurrencesSummary(request?: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, options?: CallOptions): Promise<[ protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary, protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | undefined, {} | undefined ]>; getVulnerabilityOccurrencesSummary(request: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary, protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void; getVulnerabilityOccurrencesSummary(request: protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest, callback: Callback<protos.google.devtools.containeranalysis.v1.IVulnerabilityOccurrencesSummary, protos.google.devtools.containeranalysis.v1.IGetVulnerabilityOccurrencesSummaryRequest | null | undefined, {} | null | undefined>): void; /** * Generates an SBOM for the given resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the resource in the form of * `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. * @param {google.devtools.containeranalysis.v1.ExportSBOMRequest.CloudStorageLocation} [request.cloudStorageLocation] * Optional. Empty placeholder to denote that this is a Google Cloud Storage * export request. * @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 {@link protos.google.devtools.containeranalysis.v1.ExportSBOMResponse|ExportSBOMResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example <caption>include:samples/generated/v1/container_analysis.export_s_b_o_m.js</caption> * region_tag:containeranalysis_v1_generated_ContainerAnalysis_ExportSBOM_async */ exportSBOM(request?: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, options?: CallOptions): Promise<[ protos.google.devtools.containeranalysis.v1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | undefined, {} | undefined ]>; exportSBOM(request: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void; exportSBOM(request: protos.google.devtools.containeranalysis.v1.IExportSBOMRequest, callback: Callback<protos.google.devtools.containeranalysis.v1.IExportSBOMResponse, protos.google.devtools.containeranalysis.v1.IExportSBOMRequest | null | undefined, {} | null | undefined>): void; /** * 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>; /** * Returns an instance of a @google-cloud/grafeas client, configured to * connect to Google Cloud's Container Analysis API. For documentation * on this client, see: * <a href="https://googleapis.dev/nodejs/grafeas/latest/index.html">https://googleapis.dev/nodejs/grafeas/latest/index.html</a> * * @returns {GrafeasClient} - An instance of a Grafeas client. * */ getGrafeasClient(): import("@google-cloud/grafeas/build/src/v1").GrafeasClient; }