OS Config API: Node.js Client

Osconfig client for Node.js

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

• OS Config API Node.js Client API Reference
• OS Config API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-osconfig

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
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

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

Installing the client library

 npm install @google-cloud/os-config 

Using the client library

 // Imports the Google Cloud client library
const {OsConfigServiceClient} = require(' @google-cloud/os-config 
');

// Creates a client
const client = new OsConfigServiceClient 
();

// project = 'my-project' // Project to list deployments for.

async function listPatchDeployments() {
  const [deployments] = await client.listPatchDeployments({
    parent: `projects/${project}`,
  });
  console.info(`found ${deployments.length} deployments:`);
  console.info(deployments);
}
const listPatchDeploymentsResponse = listPatchDeployments(); 

Samples

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

Sample	Source Code	Try it
Os_config_service.cancel_patch_job	source code
Os_config_service.create_patch_deployment	source code
Os_config_service.delete_patch_deployment	source code
Os_config_service.execute_patch_job	source code
Os_config_service.get_patch_deployment	source code
Os_config_service.get_patch_job	source code
Os_config_service.list_patch_deployments	source code
Os_config_service.list_patch_job_instance_details	source code
Os_config_service.list_patch_jobs	source code
Os_config_service.pause_patch_deployment	source code
Os_config_service.resume_patch_deployment	source code
Os_config_service.update_patch_deployment	source code
Os_config_zonal_service.create_o_s_policy_assignment	source code
Os_config_zonal_service.delete_o_s_policy_assignment	source code
Os_config_zonal_service.get_inventory	source code
Os_config_zonal_service.get_o_s_policy_assignment	source code
Os_config_zonal_service.get_o_s_policy_assignment_report	source code
Os_config_zonal_service.get_vulnerability_report	source code
Os_config_zonal_service.list_inventories	source code
Os_config_zonal_service.list_o_s_policy_assignment_reports	source code
Os_config_zonal_service.list_o_s_policy_assignment_revisions	source code
Os_config_zonal_service.list_o_s_policy_assignments	source code
Os_config_zonal_service.list_vulnerability_reports	source code
Os_config_zonal_service.update_o_s_policy_assignment	source code
Os_config_zonal_service.create_o_s_policy_assignment	source code
Os_config_zonal_service.delete_o_s_policy_assignment	source code
Os_config_zonal_service.get_instance_o_s_policies_compliance	source code
Os_config_zonal_service.get_inventory	source code
Os_config_zonal_service.get_o_s_policy_assignment	source code
Os_config_zonal_service.get_o_s_policy_assignment_report	source code
Os_config_zonal_service.get_vulnerability_report	source code
Os_config_zonal_service.list_instance_o_s_policies_compliances	source code
Os_config_zonal_service.list_inventories	source code
Os_config_zonal_service.list_o_s_policy_assignment_reports	source code
Os_config_zonal_service.list_o_s_policy_assignment_revisions	source code
Os_config_zonal_service.list_o_s_policy_assignments	source code
Os_config_zonal_service.list_vulnerability_reports	source code
Os_config_zonal_service.update_o_s_policy_assignment	source code
Os_config_service.cancel_patch_job	source code
Os_config_service.create_guest_policy	source code
Os_config_service.create_patch_deployment	source code
Os_config_service.delete_guest_policy	source code
Os_config_service.delete_patch_deployment	source code
Os_config_service.execute_patch_job	source code
Os_config_service.get_guest_policy	source code
Os_config_service.get_patch_deployment	source code
Os_config_service.get_patch_job	source code
Os_config_service.list_guest_policies	source code
Os_config_service.list_patch_deployments	source code
Os_config_service.list_patch_job_instance_details	source code
Os_config_service.list_patch_jobs	source code
Os_config_service.lookup_effective_guest_policy	source code
Os_config_service.pause_patch_deployment	source code
Os_config_service.resume_patch_deployment	source code
Os_config_service.update_guest_policy	source code
Os_config_service.update_patch_deployment	source code
Quickstart	source code

The OS Config API 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/os-config@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