ContextQMD
Back to Google Cloud Node

[Container Analysis API: Nodejs Client][homepage]

packages/google-devtools-containeranalysis/README.md

0.57.012.7 KB
Original Source

Container Analysis API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

Container Analysis API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

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

Installing the client library

bash
npm install @google-cloud/containeranalysis

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource Code
export s b o msource code
get iam policysource code
get vulnerability occurrences summarysource code
set iam policysource code
test iam permissionssource code
batch create notessource code
batch create occurrencessource code
create notesource code
create occurrencesource code
delete notesource code
delete occurrencesource code
get notesource code
get occurrencesource code
get occurrence notesource code
list note occurrencessource code
list notessource code
list occurrencessource code
update notesource code
update occurrencesource code
devtoolssource code
export s b o msource code
generate packages summarysource code
get iam policysource code
set iam policysource code
test iam permissionssource code
batch create notessource code
batch create occurrencessource code
create notesource code
create occurrencesource code
delete notesource code
delete occurrencesource code
get notesource code
get occurrencesource code
get occurrence notesource code
get vulnerability occurrences summarysource code
list note occurrencessource code
list notessource code
list occurrencessource code
update notesource code
update occurrencesource code
devtoolssource code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-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, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/containeranalysis@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE