Class protos.google.cloud.gaming.v1.GameServerClustersService (3.2.2)

Version latest

• 3.2.2 (latest)
• 3.2.1
• 3.1.3
• 2.5.0
• 2.4.0
• 2.3.8

Represents a GameServerClustersService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.gaming.v1.GameServerClustersService

Package

@google-cloud/game-servers

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new GameServerClustersService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): GameServerClustersService;

Creates new GameServerClustersService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
GameServerClustersService	RPC service. Useful where requests and/or responses are streamed.

createGameServerCluster(request, callback)

public createGameServerCluster(request: google.cloud.gaming.v1.ICreateGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.CreateGameServerClusterCallback): void;

Calls CreateGameServerCluster.

Parameters
Name	Description
request	ICreateGameServerClusterRequest CreateGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.CreateGameServerClusterCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createGameServerCluster(request)

public createGameServerCluster(request: google.cloud.gaming.v1.ICreateGameServerClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateGameServerCluster.

Parameter
Name	Description
request	ICreateGameServerClusterRequest CreateGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteGameServerCluster(request, callback)

public deleteGameServerCluster(request: google.cloud.gaming.v1.IDeleteGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.DeleteGameServerClusterCallback): void;

Calls DeleteGameServerCluster.

Parameters
Name	Description
request	IDeleteGameServerClusterRequest DeleteGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.DeleteGameServerClusterCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteGameServerCluster(request)

public deleteGameServerCluster(request: google.cloud.gaming.v1.IDeleteGameServerClusterRequest): Promise<google.longrunning.Operation>;

Calls DeleteGameServerCluster.

Parameter
Name	Description
request	IDeleteGameServerClusterRequest DeleteGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getGameServerCluster(request, callback)

public getGameServerCluster(request: google.cloud.gaming.v1.IGetGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.GetGameServerClusterCallback): void;

Calls GetGameServerCluster.

Parameters
Name	Description
request	google.cloud.gaming.v1.IGetGameServerClusterRequest GetGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.GetGameServerClusterCallback Node-style callback called with the error, if any, and GameServerCluster

Returns
Type	Description
void

getGameServerCluster(request)

public getGameServerCluster(request: google.cloud.gaming.v1.IGetGameServerClusterRequest): Promise<google.cloud.gaming.v1.GameServerCluster>;

Calls GetGameServerCluster.

Parameter
Name	Description
request	google.cloud.gaming.v1.IGetGameServerClusterRequest GetGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gaming.v1.GameServerCluster>	Promise

listGameServerClusters(request, callback)

public listGameServerClusters(request: google.cloud.gaming.v1.IListGameServerClustersRequest, callback: google.cloud.gaming.v1.GameServerClustersService.ListGameServerClustersCallback): void;

Calls ListGameServerClusters.

Parameters
Name	Description
request	IListGameServerClustersRequest ListGameServerClustersRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.ListGameServerClustersCallback Node-style callback called with the error, if any, and ListGameServerClustersResponse

Returns
Type	Description
void

listGameServerClusters(request)

public listGameServerClusters(request: google.cloud.gaming.v1.IListGameServerClustersRequest): Promise<google.cloud.gaming.v1.ListGameServerClustersResponse>;

Calls ListGameServerClusters.

Parameter
Name	Description
request	IListGameServerClustersRequest ListGameServerClustersRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gaming.v1.ListGameServerClustersResponse>	Promise

previewCreateGameServerCluster(request, callback)

public previewCreateGameServerCluster(request: google.cloud.gaming.v1.IPreviewCreateGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.PreviewCreateGameServerClusterCallback): void;

Calls PreviewCreateGameServerCluster.

Parameters
Name	Description
request	IPreviewCreateGameServerClusterRequest PreviewCreateGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.PreviewCreateGameServerClusterCallback Node-style callback called with the error, if any, and PreviewCreateGameServerClusterResponse

Returns
Type	Description
void

previewCreateGameServerCluster(request)

public previewCreateGameServerCluster(request: google.cloud.gaming.v1.IPreviewCreateGameServerClusterRequest): Promise<google.cloud.gaming.v1.PreviewCreateGameServerClusterResponse>;

Calls PreviewCreateGameServerCluster.

Parameter
Name	Description
request	IPreviewCreateGameServerClusterRequest PreviewCreateGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gaming.v1.PreviewCreateGameServerClusterResponse>	Promise

previewDeleteGameServerCluster(request, callback)

public previewDeleteGameServerCluster(request: google.cloud.gaming.v1.IPreviewDeleteGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.PreviewDeleteGameServerClusterCallback): void;

Calls PreviewDeleteGameServerCluster.

Parameters
Name	Description
request	IPreviewDeleteGameServerClusterRequest PreviewDeleteGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.PreviewDeleteGameServerClusterCallback Node-style callback called with the error, if any, and PreviewDeleteGameServerClusterResponse

Returns
Type	Description
void

previewDeleteGameServerCluster(request)

public previewDeleteGameServerCluster(request: google.cloud.gaming.v1.IPreviewDeleteGameServerClusterRequest): Promise<google.cloud.gaming.v1.PreviewDeleteGameServerClusterResponse>;

Calls PreviewDeleteGameServerCluster.

Parameter
Name	Description
request	IPreviewDeleteGameServerClusterRequest PreviewDeleteGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gaming.v1.PreviewDeleteGameServerClusterResponse>	Promise

previewUpdateGameServerCluster(request, callback)

public previewUpdateGameServerCluster(request: google.cloud.gaming.v1.IPreviewUpdateGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.PreviewUpdateGameServerClusterCallback): void;

Calls PreviewUpdateGameServerCluster.

Parameters
Name	Description
request	IPreviewUpdateGameServerClusterRequest PreviewUpdateGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.PreviewUpdateGameServerClusterCallback Node-style callback called with the error, if any, and PreviewUpdateGameServerClusterResponse

Returns
Type	Description
void

previewUpdateGameServerCluster(request)

public previewUpdateGameServerCluster(request: google.cloud.gaming.v1.IPreviewUpdateGameServerClusterRequest): Promise<google.cloud.gaming.v1.PreviewUpdateGameServerClusterResponse>;

Calls PreviewUpdateGameServerCluster.

Parameter
Name	Description
request	IPreviewUpdateGameServerClusterRequest PreviewUpdateGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.cloud.gaming.v1.PreviewUpdateGameServerClusterResponse>	Promise

updateGameServerCluster(request, callback)

public updateGameServerCluster(request: google.cloud.gaming.v1.IUpdateGameServerClusterRequest, callback: google.cloud.gaming.v1.GameServerClustersService.UpdateGameServerClusterCallback): void;

Calls UpdateGameServerCluster.

Parameters
Name	Description
request	IUpdateGameServerClusterRequest UpdateGameServerClusterRequest message or plain object
callback	google.cloud.gaming.v1.GameServerClustersService.UpdateGameServerClusterCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateGameServerCluster(request)

public updateGameServerCluster(request: google.cloud.gaming.v1.IUpdateGameServerClusterRequest): Promise<google.longrunning.Operation>;

Calls UpdateGameServerCluster.

Parameter
Name	Description
request	IUpdateGameServerClusterRequest UpdateGameServerClusterRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise