Stay organized with collections Save and categorize content based on your preferences.

: Node.js Client

release level npm version

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

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the API.
  4. 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/bigquery-datapolicies

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. Resource name of the project for which to list data policies. Format is
 *  `projects/{project_number}/locations/{location_id}`.
 */
// const parent = 'abc123'
/**
 *  The maximum number of data policies to return. Must be a value between 1
 *  and 1000.
 *  If not set, defaults to 50.
 */
// const pageSize = 1234
/**
 *  The `nextPageToken` value returned from a previous list request, if any. If
 *  not set, defaults to an empty string.
 */
// const pageToken = 'abc123'

// Imports the Datapolicies library
const {DataPolicyServiceClient} =
  require('@google-cloud/bigquery-datapolicies').v1beta1;

// Instantiates a client
const datapoliciesClient = new DataPolicyServiceClient();

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

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

callListDataPolicies();

Samples

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

SampleSource CodeTry it
Data_policy_service.create_data_policysource codeOpen in Cloud Shell
Data_policy_service.delete_data_policysource codeOpen in Cloud Shell
Data_policy_service.get_data_policysource codeOpen in Cloud Shell
Data_policy_service.get_iam_policysource codeOpen in Cloud Shell
Data_policy_service.list_data_policiessource codeOpen in Cloud Shell
Data_policy_service.rename_data_policysource codeOpen in Cloud Shell
Data_policy_service.set_iam_policysource codeOpen in Cloud Shell
Data_policy_service.test_iam_permissionssource codeOpen in Cloud Shell
Data_policy_service.update_data_policysource codeOpen in Cloud Shell
Data_policy_service.create_data_policysource codeOpen in Cloud Shell
Data_policy_service.delete_data_policysource codeOpen in Cloud Shell
Data_policy_service.get_data_policysource codeOpen in Cloud Shell
Data_policy_service.get_iam_policysource codeOpen in Cloud Shell
Data_policy_service.list_data_policiessource codeOpen in Cloud Shell
Data_policy_service.set_iam_policysource codeOpen in Cloud Shell
Data_policy_service.test_iam_permissionssource codeOpen in Cloud Shell
Data_policy_service.update_data_policysource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The 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/bigquery-datapolicies@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