Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ContainerAnalysis

import { ContainerAnalysis } from "https://googleapis.deno.dev/v1/containeranalysis:v1.ts";

This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.

class ContainerAnalysis {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsNotesGet(name: string): Promise<Note>;
async projectsLocationsNotesList(parent: string, opts?: ProjectsLocationsNotesListOptions): Promise<ListNotesResponse>;
async projectsLocationsNotesOccurrencesList(name: string, opts?: ProjectsLocationsNotesOccurrencesListOptions): Promise<ListNoteOccurrencesResponse>;
async projectsLocationsOccurrencesGet(name: string): Promise<Occurrence>;
async projectsLocationsOccurrencesGetNotes(name: string): Promise<Note>;
async projectsLocationsOccurrencesGetVulnerabilitySummary(parent: string, opts?: ProjectsLocationsOccurrencesGetVulnerabilitySummaryOptions): Promise<VulnerabilityOccurrencesSummary>;
async projectsLocationsOccurrencesList(parent: string, opts?: ProjectsLocationsOccurrencesListOptions): Promise<ListOccurrencesResponse>;
async projectsLocationsResourcesExportSBOM(name: string, req: ExportSBOMRequest): Promise<ExportSBOMResponse>;
async projectsNotesBatchCreate(parent: string, req: BatchCreateNotesRequest): Promise<BatchCreateNotesResponse>;
async projectsNotesCreate(
parent: string,
req: Note,
): Promise<Note>;
async projectsNotesDelete(name: string): Promise<Empty>;
async projectsNotesGet(name: string): Promise<Note>;
async projectsNotesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;
async projectsNotesList(parent: string, opts?: ProjectsNotesListOptions): Promise<ListNotesResponse>;
async projectsNotesOccurrencesList(name: string, opts?: ProjectsNotesOccurrencesListOptions): Promise<ListNoteOccurrencesResponse>;
async projectsNotesPatch(
name: string,
req: Note,
): Promise<Note>;
async projectsNotesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsNotesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsOccurrencesBatchCreate(parent: string, req: BatchCreateOccurrencesRequest): Promise<BatchCreateOccurrencesResponse>;
async projectsOccurrencesCreate(parent: string, req: Occurrence): Promise<Occurrence>;
async projectsOccurrencesDelete(name: string): Promise<Empty>;
async projectsOccurrencesGet(name: string): Promise<Occurrence>;
async projectsOccurrencesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>;
async projectsOccurrencesGetNotes(name: string): Promise<Note>;
async projectsOccurrencesGetVulnerabilitySummary(parent: string, opts?: ProjectsOccurrencesGetVulnerabilitySummaryOptions): Promise<VulnerabilityOccurrencesSummary>;
async projectsOccurrencesList(parent: string, opts?: ProjectsOccurrencesListOptions): Promise<ListOccurrencesResponse>;
async projectsOccurrencesPatch(
name: string,
): Promise<Occurrence>;
async projectsOccurrencesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsOccurrencesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsResourcesExportSBOM(name: string, req: ExportSBOMRequest): Promise<ExportSBOMResponse>;
}

§Constructors

§
new ContainerAnalysis(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsNotesGet(name: string): Promise<Note>
[src]

Gets the specified note.

@param name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsLocationsNotesList(parent: string, opts?: ProjectsLocationsNotesListOptions): Promise<ListNotesResponse>
[src]

Lists notes for the specified project.

@param parent

Required. The name of the project to list notes for in the form of projects/[PROJECT_ID].

§
projectsLocationsNotesOccurrencesList(name: string, opts?: ProjectsLocationsNotesOccurrencesListOptions): Promise<ListNoteOccurrencesResponse>
[src]

Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

@param name

Required. The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsLocationsOccurrencesGet(name: string): Promise<Occurrence>
[src]

Gets the specified occurrence.

@param name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsLocationsOccurrencesGetNotes(name: string): Promise<Note>
[src]

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 name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsLocationsOccurrencesGetVulnerabilitySummary(parent: string, opts?: ProjectsLocationsOccurrencesGetVulnerabilitySummaryOptions): Promise<VulnerabilityOccurrencesSummary>
[src]

Gets a summary of the number and severity of occurrences.

@param parent

Required. The name of the project to get a vulnerability summary for in the form of projects/[PROJECT_ID].

§
projectsLocationsOccurrencesList(parent: string, opts?: ProjectsLocationsOccurrencesListOptions): Promise<ListOccurrencesResponse>
[src]

Lists occurrences for the specified project.

@param parent

Required. The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

§
projectsLocationsResourcesExportSBOM(name: string, req: ExportSBOMRequest): Promise<ExportSBOMResponse>
[src]

Generates an SBOM for the given resource.

@param name

Required. The name of the resource in the form of projects/[PROJECT_ID]/resources/[RESOURCE_URL].

§
projectsNotesBatchCreate(parent: string, req: BatchCreateNotesRequest): Promise<BatchCreateNotesResponse>
[src]

Creates new notes in batch.

@param parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the notes are to be created.

§
projectsNotesCreate(parent: string, req: Note, opts?: ProjectsNotesCreateOptions): Promise<Note>
[src]

Creates a new note.

@param parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the note is to be created.

§
projectsNotesDelete(name: string): Promise<Empty>
[src]

Deletes the specified note.

@param name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsNotesGet(name: string): Promise<Note>
[src]

Gets the specified note.

@param name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsNotesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>
[src]

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 resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsNotesList(parent: string, opts?: ProjectsNotesListOptions): Promise<ListNotesResponse>
[src]

Lists notes for the specified project.

@param parent

Required. The name of the project to list notes for in the form of projects/[PROJECT_ID].

§
projectsNotesOccurrencesList(name: string, opts?: ProjectsNotesOccurrencesListOptions): Promise<ListNoteOccurrencesResponse>
[src]

Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

@param name

Required. The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsNotesPatch(name: string, req: Note, opts?: ProjectsNotesPatchOptions): Promise<Note>
[src]

Updates the specified note.

@param name

Required. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

§
projectsNotesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

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 resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsNotesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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 resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsOccurrencesBatchCreate(parent: string, req: BatchCreateOccurrencesRequest): Promise<BatchCreateOccurrencesResponse>
[src]

Creates new occurrences in batch.

@param parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the occurrences are to be created.

§
projectsOccurrencesCreate(parent: string, req: Occurrence): Promise<Occurrence>
[src]

Creates a new occurrence.

@param parent

Required. The name of the project in the form of projects/[PROJECT_ID], under which the occurrence is to be created.

§
projectsOccurrencesDelete(name: string): Promise<Empty>
[src]

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 name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsOccurrencesGet(name: string): Promise<Occurrence>
[src]

Gets the specified occurrence.

@param name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsOccurrencesGetIamPolicy(resource: string, req: GetIamPolicyRequest): Promise<Policy>
[src]

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 resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsOccurrencesGetNotes(name: string): Promise<Note>
[src]

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 name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsOccurrencesGetVulnerabilitySummary(parent: string, opts?: ProjectsOccurrencesGetVulnerabilitySummaryOptions): Promise<VulnerabilityOccurrencesSummary>
[src]

Gets a summary of the number and severity of occurrences.

@param parent

Required. The name of the project to get a vulnerability summary for in the form of projects/[PROJECT_ID].

§
projectsOccurrencesList(parent: string, opts?: ProjectsOccurrencesListOptions): Promise<ListOccurrencesResponse>
[src]

Lists occurrences for the specified project.

@param parent

Required. The name of the project to list occurrences for in the form of projects/[PROJECT_ID].

§
projectsOccurrencesPatch(name: string, req: Occurrence, opts?: ProjectsOccurrencesPatchOptions): Promise<Occurrence>
[src]

Updates the specified occurrence.

@param name

Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

§
projectsOccurrencesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

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 resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsOccurrencesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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 resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsResourcesExportSBOM(name: string, req: ExportSBOMRequest): Promise<ExportSBOMResponse>
[src]

Generates an SBOM for the given resource.

@param name

Required. The name of the resource in the form of projects/[PROJECT_ID]/resources/[RESOURCE_URL].