BeyondCorp API: Node.js Client

BeyondCorp 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 BeyondCorp 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/appconnections

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The resource name of the AppConnection location using the form:
 *  `projects/{project_id}/locations/{location_id}`
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of items to return.
 *  If not specified, a default value of 50 will be used by the service.
 *  Regardless of the page_size value, the response may include a partial list
 *  and a caller should only rely on response's
 *  next_page_token BeyondCorp.ListAppConnectionsResponse.next_page_token  to
 *  determine if there are more instances left to be queried.
 */
// const pageSize = 1234
/**
 *  Optional. The next_page_token value returned from a previous
 *  ListAppConnectionsRequest, if any.
 */
// const pageToken = 'abc123'
/**
 *  Optional. A filter specifying constraints of a list operation.
 */
// const filter = 'abc123'
/**
 *  Optional. Specifies the ordering of results. See
 *  Sorting
 *  order (https://cloud.google.com/apis/design/design_patterns#sorting_order)
 *  for more information.
 */
// const orderBy = 'abc123'

// Imports the Appconnections library
const {AppConnectionsServiceClient} =
  require('@google-cloud/appconnections').v1;

// Instantiates a client
const appconnectionsClient = new AppConnectionsServiceClient();

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

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

callListAppConnections();

Samples

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

Sample	Source Code	Try it
App_connections_service.create_app_connection	source code
App_connections_service.delete_app_connection	source code
App_connections_service.get_app_connection	source code
App_connections_service.list_app_connections	source code
App_connections_service.resolve_app_connections	source code
App_connections_service.update_app_connection	source code
Quickstart	source code
Quickstart	source code

The BeyondCorp 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/appconnections@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high 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