@google-cloud/gdchardwaremanagement

GDC Hardware Management API: Node.js Client

GDC Hardware Management API client for Node.js

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

• GDC Hardware Management API Node.js Client API Reference
• GDC Hardware Management API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-gdchardwaremanagement

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

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the GDC Hardware Management API 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/gdchardwaremanagement

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 project and location to list SKUs in.
 *  Format: `projects/{project}/locations/{location}`
 */
// const parent = 'abc123'
/**
 *  Optional. Requested page size. Server may return fewer items than
 *  requested. If unspecified, server will pick an appropriate default.
 */
// const pageSize = 1234
/**
 *  Optional. A token identifying a page of results the server should return.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filtering condition. See AIP-160 (https://google.aip.dev/160).
 */
// const filter = 'abc123'
/**
 *  Optional. Hint for how to order the results.
 */
// const orderBy = 'abc123'

// Imports the Gdchardwaremanagement library
const {GDCHardwareManagementClient} =
  require('@google-cloud/gdchardwaremanagement').v1alpha;

// Instantiates a client
const gdchardwaremanagementClient = new GDCHardwareManagementClient();

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

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

callListSkus();

Samples

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

Sample	Source Code	Try it
G_d_c_hardware_management.create_comment	source code
G_d_c_hardware_management.create_hardware	source code
G_d_c_hardware_management.create_hardware_group	source code
G_d_c_hardware_management.create_order	source code
G_d_c_hardware_management.create_site	source code
G_d_c_hardware_management.create_zone	source code
G_d_c_hardware_management.delete_hardware	source code
G_d_c_hardware_management.delete_hardware_group	source code
G_d_c_hardware_management.delete_order	source code
G_d_c_hardware_management.delete_zone	source code
G_d_c_hardware_management.get_change_log_entry	source code
G_d_c_hardware_management.get_comment	source code
G_d_c_hardware_management.get_hardware	source code
G_d_c_hardware_management.get_hardware_group	source code
G_d_c_hardware_management.get_order	source code
G_d_c_hardware_management.get_site	source code
G_d_c_hardware_management.get_sku	source code
G_d_c_hardware_management.get_zone	source code
G_d_c_hardware_management.list_change_log_entries	source code
G_d_c_hardware_management.list_comments	source code
G_d_c_hardware_management.list_hardware	source code
G_d_c_hardware_management.list_hardware_groups	source code
G_d_c_hardware_management.list_orders	source code
G_d_c_hardware_management.list_sites	source code
G_d_c_hardware_management.list_skus	source code
G_d_c_hardware_management.list_zones	source code
G_d_c_hardware_management.signal_zone_state	source code
G_d_c_hardware_management.submit_order	source code
G_d_c_hardware_management.update_hardware	source code
G_d_c_hardware_management.update_hardware_group	source code
G_d_c_hardware_management.update_order	source code
G_d_c_hardware_management.update_site	source code
G_d_c_hardware_management.update_zone	source code
Quickstart	source code

The GDC Hardware Management 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/gdchardwaremanagement@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 preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

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