Nostalgic Punchcard Missing
Miss any of our Open RFC calls?Watch the recordings here! »

@google-cloud/game-servers

2.1.0 • Public • Published
Google Cloud Platform logo

Google Cloud Game Servers: Node.js Client

release level npm version codecov

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

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Game Servers 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/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. The samples' README.md has instructions for running the samples.

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

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 targetting 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 in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high 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 template in this directory.

License

Apache Version 2.0

See LICENSE

Keywords

none

Install

npm i @google-cloud/game-servers

DownloadsWeekly Downloads

11

Version

2.1.0

License

Apache-2.0

Unpacked Size

5.03 MB

Total Files

66

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar