@google-cloud/config

Infrastructure Manager API: Node.js Client

Infrastructure Manager API client for Node.js

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

• Infrastructure Manager API Node.js Client API Reference
• Infrastructure Manager API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-config

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

• Select or create a Cloud Platform project.
• Enable billing for your project.
• Enable the Infrastructure Manager API 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/config

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent in whose context the Deployments are listed. The
 *  parent value is in the format:
 *  'projects/{project_id}/locations/{location}'.
 */
// const parent = 'abc123'
/**
 *  When requesting a page of resources, 'page_size' specifies number of
 *  resources to return. If unspecified or set to 0, all resources will be
 *  returned.
 */
// const pageSize = 1234
/**
 *  Token returned by previous call to 'ListDeployments' which specifies the
 *  position in the list from where to continue listing the resources.
 */
// const pageToken = 'abc123'
/**
 *  Lists the Deployments that match the filter expression. A filter
 *  expression filters the resources listed in the response. The expression
 *  must be of the form '{field} {operator} {value}' where operators: '<', '>',
 *  '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS
 *  operator which is roughly synonymous with equality). {field} can refer to a
 *  proto or JSON field, or a synthetic field. Field names can be camelCase or
 *  snake_case.
 *  Examples:
 *  - Filter by name:
 *    name = "projects/foo/locations/us-central1/deployments/bar
 *  - Filter by labels:
 *    - Resources that have a key called 'foo'
 *      labels.foo:*
 *    - Resources that have a key called 'foo' whose value is 'bar'
 *      labels.foo = bar
 *  - Filter by state:
 *    - Deployments in CREATING state.
 *      state=CREATING
 */
// const filter = 'abc123'
/**
 *  Field to use to sort the list.
 */
// const orderBy = 'abc123'

// Imports the Config library
const {ConfigClient} = require('@google-cloud/config').v1;

// Instantiates a client
const configClient = new ConfigClient();

async function callListDeployments() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await configClient.listDeploymentsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListDeployments();

Samples

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

Sample	Source Code	Try it
Config.create_deployment	source code
Config.create_preview	source code
Config.delete_deployment	source code
Config.delete_preview	source code
Config.delete_statefile	source code
Config.export_deployment_statefile	source code
Config.export_lock_info	source code
Config.export_preview_result	source code
Config.export_revision_statefile	source code
Config.get_deployment	source code
Config.get_preview	source code
Config.get_resource	source code
Config.get_revision	source code
Config.get_terraform_version	source code
Config.import_statefile	source code
Config.list_deployments	source code
Config.list_previews	source code
Config.list_resources	source code
Config.list_revisions	source code
Config.list_terraform_versions	source code
Config.lock_deployment	source code
Config.unlock_deployment	source code
Config.update_deployment	source code
Quickstart	source code

The Infrastructure Manager 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/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 stable libraries 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