Anthos Multi-Cloud API: Node.js Client

Anthos Multi-Cloud 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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

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

Installing the client library

 npm install @google-cloud/gkemulticloud

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 location which owns this collection of
 *  AwsCluster google.cloud.gkemulticloud.v1.AwsCluster  resources.
 *  Location names are formatted as `projects/<project-id>/locations/<region>`.
 *  See Resource Names (https://cloud.google.com/apis/design/resource_names)
 *  for more details on GCP resource names.
 */
// const parent = 'abc123'
/**
 *  The maximum number of items to return.
 *  If not specified, a default value of 50 will be used by the service.
 *  Regardless of the pageSize value, the response can include a partial list
 *  and a caller should only rely on response's
 *  nextPageToken google.cloud.gkemulticloud.v1.ListAwsClustersResponse.next_page_token  to determine if
 *  there are more instances left to be queried.
 */
// const pageSize = 1234
/**
 *  The `nextPageToken` value returned from a previous
 *  awsClusters.list google.cloud.gkemulticloud.v1.AwsClusters.ListAwsClusters  request, if any.
 */
// const pageToken = 'abc123'

// Imports the Gkemulticloud library
const {AwsClustersClient} = require(' @google-cloud/gkemulticloud 
').v1;

// Instantiates a client
const gkemulticloudClient = new AwsClustersClient 
({
  // API endpoint must be set:
  apiEndpoint: 'us-west1-gkemulticloud.googleapis.com',
});

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

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

callListAwsClusters();

Samples

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

Sample	Source Code	Try it
Attached_clusters.create_attached_cluster	source code
Attached_clusters.delete_attached_cluster	source code
Attached_clusters.generate_attached_cluster_agent_token	source code
Attached_clusters.generate_attached_cluster_install_manifest	source code
Attached_clusters.get_attached_cluster	source code
Attached_clusters.get_attached_server_config	source code
Attached_clusters.import_attached_cluster	source code
Attached_clusters.list_attached_clusters	source code
Attached_clusters.update_attached_cluster	source code
Aws_clusters.create_aws_cluster	source code
Aws_clusters.create_aws_node_pool	source code
Aws_clusters.delete_aws_cluster	source code
Aws_clusters.delete_aws_node_pool	source code
Aws_clusters.generate_aws_access_token	source code
Aws_clusters.generate_aws_cluster_agent_token	source code
Aws_clusters.get_aws_cluster	source code
Aws_clusters.get_aws_json_web_keys	source code
Aws_clusters.get_aws_node_pool	source code
Aws_clusters.get_aws_open_id_config	source code
Aws_clusters.get_aws_server_config	source code
Aws_clusters.list_aws_clusters	source code
Aws_clusters.list_aws_node_pools	source code
Aws_clusters.rollback_aws_node_pool_update	source code
Aws_clusters.update_aws_cluster	source code
Aws_clusters.update_aws_node_pool	source code
Azure_clusters.create_azure_client	source code
Azure_clusters.create_azure_cluster	source code
Azure_clusters.create_azure_node_pool	source code
Azure_clusters.delete_azure_client	source code
Azure_clusters.delete_azure_cluster	source code
Azure_clusters.delete_azure_node_pool	source code
Azure_clusters.generate_azure_access_token	source code
Azure_clusters.generate_azure_cluster_agent_token	source code
Azure_clusters.get_azure_client	source code
Azure_clusters.get_azure_cluster	source code
Azure_clusters.get_azure_json_web_keys	source code
Azure_clusters.get_azure_node_pool	source code
Azure_clusters.get_azure_open_id_config	source code
Azure_clusters.get_azure_server_config	source code
Azure_clusters.list_azure_clients	source code
Azure_clusters.list_azure_clusters	source code
Azure_clusters.list_azure_node_pools	source code
Azure_clusters.update_azure_cluster	source code
Azure_clusters.update_azure_node_pool	source code
Quickstart	source code

The Anthos Multi-Cloud 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/gkemulticloud@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