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
Game_server_clusters_service.create_game_server_cluster	source code
Game_server_clusters_service.delete_game_server_cluster	source code
Game_server_clusters_service.get_game_server_cluster	source code
Game_server_clusters_service.list_game_server_clusters	source code
Game_server_clusters_service.preview_create_game_server_cluster	source code
Game_server_clusters_service.preview_delete_game_server_cluster	source code
Game_server_clusters_service.preview_update_game_server_cluster	source code
Game_server_clusters_service.update_game_server_cluster	source code
Game_server_configs_service.create_game_server_config	source code
Game_server_configs_service.delete_game_server_config	source code
Game_server_configs_service.get_game_server_config	source code
Game_server_configs_service.list_game_server_configs	source code
Game_server_deployments_service.create_game_server_deployment	source code
Game_server_deployments_service.delete_game_server_deployment	source code
Game_server_deployments_service.fetch_deployment_state	source code
Game_server_deployments_service.get_game_server_deployment	source code
Game_server_deployments_service.get_game_server_deployment_rollout	source code
Game_server_deployments_service.list_game_server_deployments	source code
Game_server_deployments_service.preview_game_server_deployment_rollout	source code
Game_server_deployments_service.update_game_server_deployment	source code
Game_server_deployments_service.update_game_server_deployment_rollout	source code
Realms_service.create_realm	source code
Realms_service.delete_realm	source code
Realms_service.get_realm	source code
Realms_service.list_realms	source code
Realms_service.preview_realm_update	source code
Realms_service.update_realm	source code
Game_server_clusters_service.create_game_server_cluster	source code
Game_server_clusters_service.delete_game_server_cluster	source code
Game_server_clusters_service.get_game_server_cluster	source code
Game_server_clusters_service.list_game_server_clusters	source code
Game_server_clusters_service.preview_create_game_server_cluster	source code
Game_server_clusters_service.preview_delete_game_server_cluster	source code
Game_server_clusters_service.preview_update_game_server_cluster	source code
Game_server_clusters_service.update_game_server_cluster	source code
Game_server_configs_service.create_game_server_config	source code
Game_server_configs_service.delete_game_server_config	source code
Game_server_configs_service.get_game_server_config	source code
Game_server_configs_service.list_game_server_configs	source code
Game_server_deployments_service.create_game_server_deployment	source code
Game_server_deployments_service.delete_game_server_deployment	source code
Game_server_deployments_service.fetch_deployment_state	source code
Game_server_deployments_service.get_game_server_deployment	source code
Game_server_deployments_service.get_game_server_deployment_rollout	source code
Game_server_deployments_service.list_game_server_deployments	source code
Game_server_deployments_service.preview_game_server_deployment_rollout	source code
Game_server_deployments_service.update_game_server_deployment	source code
Game_server_deployments_service.update_game_server_deployment_rollout	source code
Realms_service.create_realm	source code
Realms_service.delete_realm	source code
Realms_service.get_realm	source code
Realms_service.list_realms	source code
Realms_service.preview_realm_update	source code
Realms_service.update_realm	source code
Create Game Server Realm	source code
Quickstart.test	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. 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/game-servers@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