Google Container Analysis: Node.js Client
Containeranalysis client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- Google Container Analysis Node.js Client API Reference
- Google Container Analysis Documentation
- github.com/googleapis/google-cloud-node/packages/google-devtools-containeranalysis
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
- Select or create a Cloud Platform project .
- Enable billing for your project .
- Enable the Google Container Analysis API .
- Set up authentication with a service account so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/containeranalysis
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
|
Container_analysis.get_iam_policy
|
source code | 
|
|
Container_analysis.get_vulnerability_occurrences_summary
|
source code |
|
|
Container_analysis.set_iam_policy
|
source code |
|
|
Container_analysis.test_iam_permissions
|
source code |
|
|
Grafeas.batch_create_notes
|
source code |
|
|
Grafeas.batch_create_occurrences
|
source code |
|
|
Grafeas.create_note
|
source code |
|
|
Grafeas.create_occurrence
|
source code |
|
|
Grafeas.delete_note
|
source code |
|
|
Grafeas.delete_occurrence
|
source code |
|
|
Grafeas.get_note
|
source code |
|
|
Grafeas.get_occurrence
|
source code |
|
|
Grafeas.get_occurrence_note
|
source code |
|
|
Grafeas.list_note_occurrences
|
source code |
|
|
Grafeas.list_notes
|
source code |
|
|
Grafeas.list_occurrences
|
source code |
|
|
Grafeas.update_note
|
source code |
|
|
Grafeas.update_occurrence
|
source code |
|
|
Container_analysis_v1_beta1.export_s_b_o_m
|
source code |
|
|
Container_analysis_v1_beta1.generate_packages_summary
|
source code |
|
|
Container_analysis_v1_beta1.get_iam_policy
|
source code |
|
|
Container_analysis_v1_beta1.get_scan_config
|
source code |
|
|
Container_analysis_v1_beta1.list_scan_configs
|
source code |
|
|
Container_analysis_v1_beta1.set_iam_policy
|
source code |
|
|
Container_analysis_v1_beta1.test_iam_permissions
|
source code |
|
|
Container_analysis_v1_beta1.update_scan_config
|
source code |
|
|
Grafeas_v1_beta1.batch_create_notes
|
source code |
|
|
Grafeas_v1_beta1.batch_create_occurrences
|
source code |
|
|
Grafeas_v1_beta1.create_note
|
source code |
|
|
Grafeas_v1_beta1.create_occurrence
|
source code |
|
|
Grafeas_v1_beta1.delete_note
|
source code |
|
|
Grafeas_v1_beta1.delete_occurrence
|
source code |
|
|
Grafeas_v1_beta1.get_note
|
source code |
|
|
Grafeas_v1_beta1.get_occurrence
|
source code |
|
|
Grafeas_v1_beta1.get_occurrence_note
|
source code |
|
|
Grafeas_v1_beta1.get_vulnerability_occurrences_summary
|
source code |
|
|
Grafeas_v1_beta1.list_note_occurrences
|
source code |
|
|
Grafeas_v1_beta1.list_notes
|
source code |
|
|
Grafeas_v1_beta1.list_occurrences
|
source code |
|
|
Grafeas_v1_beta1.update_note
|
source code |
|
|
Grafeas_v1_beta1.update_occurrence
|
source code |
|
|
Quickstart
|
source code |
|
The Google Container Analysis Node.js Client API Reference documentation also contains samples.
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 .
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 stablelibraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in directory
.
License
Apache Version 2.0
See LICENSE
