Google Container Analysis: Node.js Client

Container Analysis API client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

• Google Container Analysis Node.js Client API Reference
• Google Container Analysis Documentation
• github.com/googleapis/nodejs-containeranalysis

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Google Container Analysis API.
4. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/containeranalysis

Using the client library

/** * TODO(developer): Uncomment these variables before running the sample */// const projectId = 'your-project-id', // Your GCP Project ID// const noteId = 'my-note-id' // Id of the note// Import the library and create a clientconst {ContainerAnalysisClient} = require('@google-cloud/containeranalysis');const client = newContainerAnalysisClient();// Fetch an instance of a Grafeas client:// see: https://googleapis.dev/nodejs/grafeas/latestconst grafeasClient = client.getGrafeasClient();// Construct request// Associate the Note with a metadata type// https://cloud.google.com/container-registry/docs/container-analysis#supported_metadata_types// Here, we use the type "vulnerabiltity"const formattedParent = grafeasClient.projectPath(projectId);// Creates and returns a new Noteconst [note] = await grafeasClient.createNote({  parent: formattedParent,  noteId: noteId,  note: {    vulnerability: {      details: [        {          affectedCpeUri: 'foo.uri',          affectedPackage: 'foo',          minAffectedVersion: {            kind: 'MINIMUM',          },          fixedVersion: {            kind: 'MAXIMUM',          },        },      ],    },  },});console.log(`Note ${note.name} created.`);

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Create Note	source code
Create Occurrence	source code
Delete Note	source code
Delete Occurrence	source code
Get Discovery Info	source code
Get Note	source code
Get Occurrence	source code
Get High Vulnerabilities for Image	source code
Occurrence PubSub	source code
Occurrences for Image	source code
Occurrences for Note	source code
Poll Discovery Occurrence Finished	source code
Quickstart	source code
Vulnerability Occurrences for Image	source code

TheGoogle Container Analysis Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/containeranalysis@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE