@google-cloud/policysimulator

Policy Simulator API: Node.js Client

Policy Simulator API client for Node.js

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

• Policy Simulator API Node.js Client API Reference
• Policy Simulator API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-policysimulator

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 Policy Simulator API API.
• Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/policysimulator

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 Replay google.cloud.policysimulator.v1.Replay  whose
 *  results are listed, in the following format:
 *  `{projects|folders|organizations}/{resource-id}/locations/global/replays/{replay-id}`
 *  Example:
 *  `projects/my-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36`
 */
// const parent = 'abc123'
/**
 *  The maximum number of
 *  ReplayResult google.cloud.policysimulator.v1.ReplayResult  objects to
 *  return. Defaults to 5000.
 *  The maximum value is 5000; values above 5000 are rounded down to 5000.
 */
// const pageSize = 1234
/**
 *  A page token, received from a previous
 *  Simulator.ListReplayResults google.cloud.policysimulator.v1.Simulator.ListReplayResults
 *  call. Provide this token to retrieve the next page of results.
 *  When paginating, all other parameters provided to
 *  Simulator.ListReplayResults  must match the call that provided the page
 *  token.
 */
// const pageToken = 'abc123'

// Imports the Policysimulator library
const {SimulatorClient} = require('@google-cloud/policysimulator').v1;

// Instantiates a client
const policysimulatorClient = new SimulatorClient();

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

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

callListReplayResults();

Samples

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

Sample	Source Code	Try it
Org_policy_violations_preview_service.create_org_policy_violations_preview	source code
Org_policy_violations_preview_service.get_org_policy_violations_preview	source code
Org_policy_violations_preview_service.list_org_policy_violations	source code
Org_policy_violations_preview_service.list_org_policy_violations_previews	source code
Simulator.create_replay	source code
Simulator.get_replay	source code
Simulator.list_replay_results	source code
Quickstart	source code

The Policy Simulator 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/policysimulator@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