0.1.0 • Published 5 months ago

@google-cloud/devicestreaming v0.1.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

Device Streaming API: Node.js Client

release level npm version

Device Streaming 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

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Device Streaming API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/devicestreaming

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 name of the parent to request, e.g. "projects/{project_id}"
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of DeviceSessions to return.
 */
// const pageSize = 1234
/**
 *  Optional. A continuation token for paging.
 */
// const pageToken = 'abc123'
/**
 *  Optional. If specified, responses will be filtered by the given filter.
 *  Allowed fields are: session_state.
 */
// const filter = 'abc123'

// Imports the Devicestreaming library
const {DirectAccessServiceClient} =
  require('@google-cloud/devicestreaming').v1;

// Instantiates a client
const devicestreamingClient = new DirectAccessServiceClient();

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

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

callListDeviceSessions();

Samples

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

SampleSource CodeTry it
Direct_access_service.adb_connectsource codeOpen in Cloud Shell
Direct_access_service.cancel_device_sessionsource codeOpen in Cloud Shell
Direct_access_service.create_device_sessionsource codeOpen in Cloud Shell
Direct_access_service.get_device_sessionsource codeOpen in Cloud Shell
Direct_access_service.list_device_sessionssource codeOpen in Cloud Shell
Direct_access_service.update_device_sessionsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Device Streaming 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/devicestreaming@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