Google Cloud Game Servers: Node.js Client

Game service 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 Google Cloud Game Servers 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/game-servers

Using the client library

const {RealmsServiceClient} = require('@google-cloud/game-servers');

async function quickstart() {
  const client = new RealmsServiceClient();

  // TODO(developer): uncomment the following section, and add values
  // const projectId = 'YOUR_PROJECT_ID';
  // const location = 'us-central1;
  // const realmId = 'DESIRED_REALM_ID';

  const request = {
    parent: `projects/${projectId}/locations/${location}`,
    realmId,
    realm: {
      // Must use a valid support time zone.
      // See https://cloud.google.com/dataprep/docs/html/Supported-Time-Zone-Values_66194188
      timeZone: 'US/Pacific',
      description: 'My Game Server realm',
    },
  };

  const [operation] = await client.createRealm(request);
  const results = await operation.promise();
  const [realm] = results;

  console.log('Realm created:');

  console.log(`\tRealm name: ${realm.name}`);
  console.log(`\tRealm description: ${realm.description}`);
  console.log(`\tRealm time zone: ${realm.timeZone}`);
}
quickstart();

Samples

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

Sample	Source Code	Try it
Create_cluster	source code
Create_config	source code
Create_deployment	source code
Create_realm	source code
Delete_cluster	source code
Delete_config	source code
Delete_deployment	source code
Delete_realm	source code
Get_cluster	source code
Get_config	source code
Get_deployment	source code
Get_realm	source code
Get_rollout	source code
List_clusters	source code
List_configs	source code
List_deployments	source code
List_realms	source code
Create Game Server Realm	source code
Update_cluster	source code
Update_deployment	source code
Update_realm	source code
Update_rollout_default	source code
Update_rollout_override	source code
Update_rollout_remove_default	source code
Update_rollout_remove_override	source code

The Google Cloud Game Servers 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.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

Legacy versions will not be tested in continuous integration.
Some security patches may not be able to be backported.
Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is 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 GA 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