OS Config 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

OS Config API client for Node.js

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

OS Config API Nodejs Client API Reference

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
- Installing the client library
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the OS Config API API.
Set up authentication so you can access the API from your local workstation.

Installing the client library

bash

npm install @google-cloud/os-config

Samples

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

Sample	Source Code
cancel patch job	source code
create patch deployment	source code
delete patch deployment	source code
execute patch job	source code
get patch deployment	source code
get patch job	source code
list patch deployments	source code
list patch job instance details	source code
list patch jobs	source code
pause patch deployment	source code
resume patch deployment	source code
update patch deployment	source code
create o s policy assignment	source code
delete o s policy assignment	source code
get inventory	source code
get o s policy assignment	source code
get o s policy assignment report	source code
get vulnerability report	source code
list inventories	source code
list o s policy assignment reports	source code
list o s policy assignment revisions	source code
list o s policy assignments	source code
list vulnerability reports	source code
update o s policy assignment	source code
cloud	source code
create o s policy assignment	source code
delete o s policy assignment	source code
get instance o s policies compliance	source code
get inventory	source code
get o s policy assignment	source code
get o s policy assignment report	source code
get vulnerability report	source code
list instance o s policies compliances	source code
list inventories	source code
list o s policy assignment reports	source code
list o s policy assignment revisions	source code
list o s policy assignments	source code
list vulnerability reports	source code
update o s policy assignment	source code
cloud	source code
cancel patch job	source code
create guest policy	source code
create patch deployment	source code
delete guest policy	source code
delete patch deployment	source code
execute patch job	source code
get guest policy	source code
get patch deployment	source code
get patch job	source code
list guest policies	source code
list patch deployments	source code
list patch job instance details	source code
list patch jobs	source code
lookup effective guest policy	source code
pause patch deployment	source code
resume patch deployment	source code
update guest policy	source code
update patch deployment	source code
cloud	source 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/os-config@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

[OS Config API: Nodejs Client][homepage]