GameServerDeploymentsServiceClient

GameServerDeploymentsServiceClient

The game server deployment is used to control the deployment of Agones fleets.

Constructor

new GameServerDeploymentsServiceClient(optionsopt)

Construct an instance of GameServerDeploymentsServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

(async) checkCreateGameServerDeploymentProgress(name) → {Promise}

Check the status of the long running operation returned by the createGameServerDeployment() method.

Parameters:
Name Type Description
name String

The operation name that will be passed.

(async) checkDeleteGameServerDeploymentProgress(name) → {Promise}

Check the status of the long running operation returned by the deleteGameServerDeployment() method.

Parameters:
Name Type Description
name String

The operation name that will be passed.

(async) checkUpdateGameServerDeploymentProgress(name) → {Promise}

Check the status of the long running operation returned by the updateGameServerDeployment() method.

Parameters:
Name Type Description
name String

The operation name that will be passed.

(async) checkUpdateGameServerDeploymentRolloutProgress(name) → {Promise}

Check the status of the long running operation returned by the updateGameServerDeploymentRollout() method.

Parameters:
Name Type Description
name String

The operation name that will be passed.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

createGameServerDeployment(request, optionsopt) → {Promise}

Creates a new game server deployment in a given project and location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

deploymentId string

Required. The ID of the game server delpoyment resource to be created.

gameServerDeployment google.cloud.gaming.v1.GameServerDeployment

Required. The game server delpoyment resource to be created.

options object <optional>

Call options. See CallOptions for more details.

deleteGameServerDeployment(request, optionsopt) → {Promise}

Deletes a single game server deployment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the game server delpoyment to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

options object <optional>

Call options. See CallOptions for more details.

fetchDeploymentState(request, optionsopt) → {Promise}

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the game server delpoyment. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

options object <optional>

Call options. See CallOptions for more details.

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

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

gameServerDeploymentPath(project, location, deployment) → {string}

Return a fully-qualified gameServerDeployment resource name string.

Parameters:
Name Type Description
project string
location string
deployment string

gameServerDeploymentRolloutPath(project, location, deployment) → {string}

Return a fully-qualified gameServerDeploymentRollout resource name string.

Parameters:
Name Type Description
project string
location string
deployment string

getGameServerDeployment(request, optionsopt) → {Promise}

Gets details of a single game server deployment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the game server delpoyment to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

options object <optional>

Call options. See CallOptions for more details.

getGameServerDeploymentRollout(request, optionsopt) → {Promise}

Gets details a single game server deployment rollout.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the game server delpoyment to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

options object <optional>

Call options. See CallOptions for more details.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current 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.

listGameServerDeployments(request, optionsopt) → {Promise}

Lists game server deployments in a given project and location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

pageSize number <optional>

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried.

pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.

filter string <optional>

Optional. The filter to apply to list results.

orderBy string <optional>

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options object <optional>

Call options. See CallOptions for more details.

listGameServerDeploymentsAsync(request, optionsopt) → {Object}

Equivalent to listGameServerDeployments, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

pageSize number <optional>

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried.

pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.

filter string <optional>

Optional. The filter to apply to list results.

orderBy string <optional>

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options object <optional>

Call options. See CallOptions for more details.

listGameServerDeploymentsStream(request, optionsopt) → {Stream}

Equivalent to listGameServerDeployments, but returns a NodeJS Stream object.

This fetches the paged responses for listGameServerDeployments continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

pageSize number <optional>

Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerDeployments left to be queried.

pageToken string <optional>

Optional. The next_page_token value returned from a previous List request, if any.

filter string <optional>

Optional. The filter to apply to list results.

orderBy string <optional>

Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

options object <optional>

Call options. See CallOptions for more details.

See:

matchClusterFromGameServerClusterName(gameServerClusterName) → {string}

Parse the cluster from GameServerCluster resource.

Parameters:
Name Type Description
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

matchConfigFromGameServerConfigName(gameServerConfigName) → {string}

Parse the config from GameServerConfig resource.

Parameters:
Name Type Description
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

matchDeploymentFromGameServerConfigName(gameServerConfigName) → {string}

Parse the deployment from GameServerConfig resource.

Parameters:
Name Type Description
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

matchDeploymentFromGameServerDeploymentName(gameServerDeploymentName) → {string}

Parse the deployment from GameServerDeployment resource.

Parameters:
Name Type Description
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

matchDeploymentFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}

Parse the deployment from GameServerDeploymentRollout resource.

Parameters:
Name Type Description
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

matchLocationFromGameServerClusterName(gameServerClusterName) → {string}

Parse the location from GameServerCluster resource.

Parameters:
Name Type Description
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

matchLocationFromGameServerConfigName(gameServerConfigName) → {string}

Parse the location from GameServerConfig resource.

Parameters:
Name Type Description
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

matchLocationFromGameServerDeploymentName(gameServerDeploymentName) → {string}

Parse the location from GameServerDeployment resource.

Parameters:
Name Type Description
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

matchLocationFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}

Parse the location from GameServerDeploymentRollout resource.

Parameters:
Name Type Description
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

matchLocationFromRealmName(realmName) → {string}

Parse the location from Realm resource.

Parameters:
Name Type Description
realmName string

A fully-qualified path representing Realm resource.

matchProjectFromGameServerClusterName(gameServerClusterName) → {string}

Parse the project from GameServerCluster resource.

Parameters:
Name Type Description
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

matchProjectFromGameServerConfigName(gameServerConfigName) → {string}

Parse the project from GameServerConfig resource.

Parameters:
Name Type Description
gameServerConfigName string

A fully-qualified path representing GameServerConfig resource.

matchProjectFromGameServerDeploymentName(gameServerDeploymentName) → {string}

Parse the project from GameServerDeployment resource.

Parameters:
Name Type Description
gameServerDeploymentName string

A fully-qualified path representing GameServerDeployment resource.

matchProjectFromGameServerDeploymentRolloutName(gameServerDeploymentRolloutName) → {string}

Parse the project from GameServerDeploymentRollout resource.

Parameters:
Name Type Description
gameServerDeploymentRolloutName string

A fully-qualified path representing GameServerDeploymentRollout resource.

matchProjectFromRealmName(realmName) → {string}

Parse the project from Realm resource.

Parameters:
Name Type Description
realmName string

A fully-qualified path representing Realm resource.

matchRealmFromGameServerClusterName(gameServerClusterName) → {string}

Parse the realm from GameServerCluster resource.

Parameters:
Name Type Description
gameServerClusterName string

A fully-qualified path representing GameServerCluster resource.

matchRealmFromRealmName(realmName) → {string}

Parse the realm from Realm resource.

Parameters:
Name Type Description
realmName string

A fully-qualified path representing Realm resource.

previewGameServerDeploymentRollout(request, optionsopt) → {Promise}

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
rollout google.cloud.gaming.v1.GameServerDeploymentRollout

Required. The game server deployment rollout to be updated. Only fields specified in update_mask are updated.

updateMask google.protobuf.FieldMask <optional>

Optional. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

previewTime google.protobuf.Timestamp <optional>

Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

options object <optional>

Call options. See CallOptions for more details.

realmPath(project, location, realm) → {string}

Return a fully-qualified realm resource name string.

Parameters:
Name Type Description
project string
location string
realm string

updateGameServerDeployment(request, optionsopt) → {Promise}

Patches a game server deployment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
gameServerDeployment google.cloud.gaming.v1.GameServerDeployment

Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

updateMask google.protobuf.FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

options object <optional>

Call options. See CallOptions for more details.

updateGameServerDeploymentRollout(request, optionsopt) → {Promise}

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
rollout google.cloud.gaming.v1.GameServerDeploymentRollout

Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

updateMask google.protobuf.FieldMask

Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see

https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

options object <optional>

Call options. See CallOptions for more details.