Constructor
new RealmsServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of RealmsServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
(async) checkCreateRealmProgress(name) → {Promise}
Check the status of the long running operation returned by createRealm()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* 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 parent resource name, in the following form:
* `projects/{project}/locations/{location}`.
*/
// const parent = 'abc123'
/**
* Required. The ID of the realm resource to be created.
*/
// const realmId = 'abc123'
/**
* Required. The realm resource to be created.
*/
// const realm = {}
// Imports the Gaming library
const {RealmsServiceClient} = require('@google-cloud/game-servers').v1;
// Instantiates a client
const gamingClient = new RealmsServiceClient();
async function callCreateRealm() {
// Construct request
const request = {
parent,
realmId,
realm,
};
// Run request
const [operation] = await gamingClient.createRealm(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateRealm();
(async) checkDeleteRealmProgress(name) → {Promise}
Check the status of the long running operation returned by deleteRealm()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* 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 realm to delete, in the following form:
* `projects/{project}/locations/{location}/realms/{realm}`.
*/
// const name = 'abc123'
// Imports the Gaming library
const {RealmsServiceClient} = require('@google-cloud/game-servers').v1;
// Instantiates a client
const gamingClient = new RealmsServiceClient();
async function callDeleteRealm() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await gamingClient.deleteRealm(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteRealm();
(async) checkUpdateRealmProgress(name) → {Promise}
Check the status of the long running operation returned by updateRealm()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* 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 realm to be updated.
* Only fields specified in update_mask are updated.
*/
// const realm = {}
/**
* Required. The update mask applies to the resource. For the `FieldMask`
* definition, see
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
*/
// const updateMask = {}
// Imports the Gaming library
const {RealmsServiceClient} = require('@google-cloud/game-servers').v1;
// Instantiates a client
const gamingClient = new RealmsServiceClient();
async function callUpdateRealm() {
// Construct request
const request = {
realm,
updateMask,
};
// Run request
const [operation] = await gamingClient.updateRealm(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateRealm();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
gameServerClusterPath(project, location, realm, cluster) → {string}
Return a fully-qualified gameServerCluster resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
realm |
string | |
cluster |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
gameServerConfigPath(project, location, deployment, config) → {string}
Return a fully-qualified gameServerConfig resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
deployment |
string | |
config |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
gameServerDeploymentPath(project, location, deployment) → {string}
Return a fully-qualified gameServerDeployment resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
deployment |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
gameServerDeploymentRolloutPath(project, location, deployment) → {string}
Return a fully-qualified gameServerDeploymentRollout resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
deployment |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
listRealmsAsync(request, optionsopt) → {Object}
Equivalent to listRealms
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Realm. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* 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 parent resource name, in the following form:
* `projects/{project}/locations/{location}`.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of items to return. If unspecified, server
* will pick an appropriate default. Server may return fewer items than
* requested. A caller should only rely on response's
* next_page_token google.cloud.gaming.v1.ListRealmsResponse.next_page_token to
* determine if there are more realms left to be queried.
*/
// const pageSize = 1234
/**
* Optional. The next_page_token value returned from a previous List request,
* if any.
*/
// const pageToken = 'abc123'
/**
* Optional. The filter to apply to list results.
*/
// const filter = 'abc123'
/**
* Optional. Specifies the ordering of results following syntax at
* https://cloud.google.com/apis/design/design_patterns#sorting_order.
*/
// const orderBy = 'abc123'
// Imports the Gaming library
const {RealmsServiceClient} = require('@google-cloud/game-servers').v1;
// Instantiates a client
const gamingClient = new RealmsServiceClient();
async function callListRealms() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await gamingClient.listRealmsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRealms();
listRealmsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Realm on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
matchClusterFromGameServerClusterName(gameServerClusterName) → {string}
Parse the cluster from GameServerCluster resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerClusterName |
string |
A fully-qualified path representing GameServerCluster resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the cluster. |
matchConfigFromGameServerConfigName(gameServerConfigName) → {string}
Parse the config from GameServerConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerConfigName |
string |
A fully-qualified path representing GameServerConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the config. |
matchDeploymentFromGameServerConfigName(gameServerConfigName) → {string}
Parse the deployment from GameServerConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerConfigName |
string |
A fully-qualified path representing GameServerConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the deployment. |
matchDeploymentFromGameServerDeploymentName(gameServerDeploymentName) → {string}
Parse the deployment from GameServerDeployment resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentName |
string |
A fully-qualified path representing GameServerDeployment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the deployment. |
matchDeploymentFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}
Parse the deployment from GameServerDeploymentRollout resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentRolloutName |
string |
A fully-qualified path representing GameServerDeploymentRollout resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the deployment. |
matchLocationFromGameServerClusterName(gameServerClusterName) → {string}
Parse the location from GameServerCluster resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerClusterName |
string |
A fully-qualified path representing GameServerCluster resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromGameServerConfigName(gameServerConfigName) → {string}
Parse the location from GameServerConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerConfigName |
string |
A fully-qualified path representing GameServerConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromGameServerDeploymentName(gameServerDeploymentName) → {string}
Parse the location from GameServerDeployment resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentName |
string |
A fully-qualified path representing GameServerDeployment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}
Parse the location from GameServerDeploymentRollout resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentRolloutName |
string |
A fully-qualified path representing GameServerDeploymentRollout resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromRealmName(realmName) → {string}
Parse the location from Realm resource.
Parameters:
Name | Type | Description |
---|---|---|
realmName |
string |
A fully-qualified path representing Realm resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchProjectFromGameServerClusterName(gameServerClusterName) → {string}
Parse the project from GameServerCluster resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerClusterName |
string |
A fully-qualified path representing GameServerCluster resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromGameServerConfigName(gameServerConfigName) → {string}
Parse the project from GameServerConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerConfigName |
string |
A fully-qualified path representing GameServerConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromGameServerDeploymentName(gameServerDeploymentName) → {string}
Parse the project from GameServerDeployment resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentName |
string |
A fully-qualified path representing GameServerDeployment resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}
Parse the project from GameServerDeploymentRollout resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerDeploymentRolloutName |
string |
A fully-qualified path representing GameServerDeploymentRollout resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromRealmName(realmName) → {string}
Parse the project from Realm resource.
Parameters:
Name | Type | Description |
---|---|---|
realmName |
string |
A fully-qualified path representing Realm resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchRealmFromGameServerClusterName(gameServerClusterName) → {string}
Parse the realm from GameServerCluster resource.
Parameters:
Name | Type | Description |
---|---|---|
gameServerClusterName |
string |
A fully-qualified path representing GameServerCluster resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the realm. |
matchRealmFromRealmName(realmName) → {string}
Parse the realm from Realm resource.
Parameters:
Name | Type | Description |
---|---|---|
realmName |
string |
A fully-qualified path representing Realm resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the realm. |
realmPath(project, location, realm) → {string}
Return a fully-qualified realm resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
realm |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |