VMware Engine API: Node.js Client

VMware Engine 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 VMware Engine 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/vmwareengine

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 resource name of the location to query for
 *  VMware Engine networks. Resource names are schemeless URIs that follow the
 *  conventions in https://cloud.google.com/apis/design/resource_names. For
 *  example: `projects/my-project/locations/global`
 */
// const parent = 'abc123'
/**
 *  The maximum number of results to return in one page.
 *  The maximum value is coerced to 1000.
 *  The default value of this field is 500.
 */
// const pageSize = 1234
/**
 *  A page token, received from a previous `ListVmwareEngineNetworks` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to
 *  `ListVmwareEngineNetworks` must match the call that provided the page
 *  token.
 */
// const pageToken = 'abc123'
/**
 *  A filter expression that matches resources returned in the response.
 *  The expression must specify the field name, a comparison
 *  operator, and the value that you want to use for filtering. The value
 *  must be a string, a number, or a boolean. The comparison operator
 *  must be `=`, `!=`, `>`, or `<`.
 *  For example, if you are filtering a list of network peerings, you can
 *  exclude the ones named `example-network` by specifying
 *  `name != "example-network"`.
 *  To filter on multiple expressions, provide each separate expression within
 *  parentheses. For example:
 *  ```
 *  (name = "example-network")
 *  (createTime > "2021-04-12T08:15:10.40Z")
 *  ```
 *  By default, each expression is an `AND` expression. However, you
 *  can include `AND` and `OR` expressions explicitly.
 *  For example:
 *  ```
 *  (name = "example-network-1") AND
 *  (createTime > "2021-04-12T08:15:10.40Z") OR
 *  (name = "example-network-2")
 *  ```
 */
// const filter = 'abc123'
/**
 *  Sorts list results by a certain order. By default, returned results
 *  are ordered by `name` in ascending order.
 *  You can also sort results in descending order based on the `name` value
 *  using `orderBy="name desc"`.
 *  Currently, only ordering by `name` is supported.
 */
// const orderBy = 'abc123'

// Imports the Vmwareengine library
const {VmwareEngineClient} = require('@google-cloud/vmwareengine').v1;

// Instantiates a client
const vmwareengineClient = new VmwareEngineClient();

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

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

callListVmwareEngineNetworks();

Samples

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

Sample	Source Code	Try it
Vmware_engine.create_cluster	source code
Vmware_engine.create_hcx_activation_key	source code
Vmware_engine.create_network_policy	source code
Vmware_engine.create_private_cloud	source code
Vmware_engine.create_vmware_engine_network	source code
Vmware_engine.delete_cluster	source code
Vmware_engine.delete_network_policy	source code
Vmware_engine.delete_private_cloud	source code
Vmware_engine.delete_vmware_engine_network	source code
Vmware_engine.get_cluster	source code
Vmware_engine.get_hcx_activation_key	source code
Vmware_engine.get_network_policy	source code
Vmware_engine.get_node_type	source code
Vmware_engine.get_private_cloud	source code
Vmware_engine.get_vmware_engine_network	source code
Vmware_engine.list_clusters	source code
Vmware_engine.list_hcx_activation_keys	source code
Vmware_engine.list_network_policies	source code
Vmware_engine.list_node_types	source code
Vmware_engine.list_private_clouds	source code
Vmware_engine.list_subnets	source code
Vmware_engine.list_vmware_engine_networks	source code
Vmware_engine.reset_nsx_credentials	source code
Vmware_engine.reset_vcenter_credentials	source code
Vmware_engine.show_nsx_credentials	source code
Vmware_engine.show_vcenter_credentials	source code
Vmware_engine.undelete_private_cloud	source code
Vmware_engine.update_cluster	source code
Vmware_engine.update_network_policy	source code
Vmware_engine.update_private_cloud	source code
Vmware_engine.update_vmware_engine_network	source code
Quickstart	source code
Quickstart	source code

The VMware Engine 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/vmwareengine@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