GameServerDeploymentsService

google .cloud .gaming .v1. GameServerDeploymentsService

Represents a GameServerDeploymentsService

Constructor

new GameServerDeploymentsService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new GameServerDeploymentsService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createGameServerDeployment(request, callback) → {undefined}

Calls CreateGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.ICreateGameServerDeploymentRequest	CreateGameServerDeploymentRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.CreateGameServerDeploymentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createGameServerDeployment(request) → {Promise.<google.longrunning.Operation>}

Calls CreateGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.ICreateGameServerDeploymentRequest	CreateGameServerDeploymentRequest message or plain object

Returns:

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

deleteGameServerDeployment(request, callback) → {undefined}

Calls DeleteGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IDeleteGameServerDeploymentRequest	DeleteGameServerDeploymentRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.DeleteGameServerDeploymentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

deleteGameServerDeployment(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IDeleteGameServerDeploymentRequest	DeleteGameServerDeploymentRequest message or plain object

Returns:

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

fetchDeploymentState(request, callback) → {undefined}

Calls FetchDeploymentState.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IFetchDeploymentStateRequest	FetchDeploymentStateRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.FetchDeploymentStateCallback	Node-style callback called with the error, if any, and FetchDeploymentStateResponse

Returns:

Type	Description
undefined

fetchDeploymentState(request) → {Promise.<google.cloud.gaming.v1.FetchDeploymentStateResponse>}

Calls FetchDeploymentState.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IFetchDeploymentStateRequest	FetchDeploymentStateRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.gaming.v1.FetchDeploymentStateResponse>	Promise

getGameServerDeployment(request, callback) → {undefined}

Calls GetGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IGetGameServerDeploymentRequest	GetGameServerDeploymentRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.GetGameServerDeploymentCallback	Node-style callback called with the error, if any, and GameServerDeployment

Returns:

Type	Description
undefined

getGameServerDeployment(request) → {Promise.<google.cloud.gaming.v1.GameServerDeployment>}

Calls GetGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IGetGameServerDeploymentRequest	GetGameServerDeploymentRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.gaming.v1.GameServerDeployment>	Promise

getGameServerDeploymentRollout(request, callback) → {undefined}

Calls GetGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IGetGameServerDeploymentRolloutRequest	GetGameServerDeploymentRolloutRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.GetGameServerDeploymentRolloutCallback	Node-style callback called with the error, if any, and GameServerDeploymentRollout

Returns:

Type	Description
undefined

getGameServerDeploymentRollout(request) → {Promise.<google.cloud.gaming.v1.GameServerDeploymentRollout>}

Calls GetGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IGetGameServerDeploymentRolloutRequest	GetGameServerDeploymentRolloutRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.gaming.v1.GameServerDeploymentRollout>	Promise

listGameServerDeployments(request, callback) → {undefined}

Calls ListGameServerDeployments.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IListGameServerDeploymentsRequest	ListGameServerDeploymentsRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.ListGameServerDeploymentsCallback	Node-style callback called with the error, if any, and ListGameServerDeploymentsResponse

Returns:

Type	Description
undefined

listGameServerDeployments(request) → {Promise.<google.cloud.gaming.v1.ListGameServerDeploymentsResponse>}

Calls ListGameServerDeployments.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IListGameServerDeploymentsRequest	ListGameServerDeploymentsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.gaming.v1.ListGameServerDeploymentsResponse>	Promise

previewGameServerDeploymentRollout(request, callback) → {undefined}

Calls PreviewGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IPreviewGameServerDeploymentRolloutRequest	PreviewGameServerDeploymentRolloutRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.PreviewGameServerDeploymentRolloutCallback	Node-style callback called with the error, if any, and PreviewGameServerDeploymentRolloutResponse

Returns:

Type	Description
undefined

previewGameServerDeploymentRollout(request) → {Promise.<google.cloud.gaming.v1.PreviewGameServerDeploymentRolloutResponse>}

Calls PreviewGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IPreviewGameServerDeploymentRolloutRequest	PreviewGameServerDeploymentRolloutRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.gaming.v1.PreviewGameServerDeploymentRolloutResponse>	Promise

updateGameServerDeployment(request, callback) → {undefined}

Calls UpdateGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IUpdateGameServerDeploymentRequest	UpdateGameServerDeploymentRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.UpdateGameServerDeploymentCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateGameServerDeployment(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateGameServerDeployment.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IUpdateGameServerDeploymentRequest	UpdateGameServerDeploymentRequest message or plain object

Returns:

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

updateGameServerDeploymentRollout(request, callback) → {undefined}

Calls UpdateGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IUpdateGameServerDeploymentRolloutRequest	UpdateGameServerDeploymentRolloutRequest message or plain object
`callback`	google.cloud.gaming.v1.GameServerDeploymentsService.UpdateGameServerDeploymentRolloutCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateGameServerDeploymentRollout(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateGameServerDeploymentRollout.

Parameters:

Name	Type	Description
`request`	google.cloud.gaming.v1.IUpdateGameServerDeploymentRolloutRequest	UpdateGameServerDeploymentRolloutRequest message or plain object

Returns:

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

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {GameServerDeploymentsService}

Creates new GameServerDeploymentsService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

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

Type Definitions

CreateGameServerDeploymentCallback(error, responseopt)

Callback as used by createGameServerDeployment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteGameServerDeploymentCallback(error, responseopt)

Callback as used by deleteGameServerDeployment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

FetchDeploymentStateCallback(error, responseopt)

Callback as used by fetchDeploymentState.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.gaming.v1.FetchDeploymentStateResponse	<optional>	FetchDeploymentStateResponse

GetGameServerDeploymentCallback(error, responseopt)

Callback as used by getGameServerDeployment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.gaming.v1.GameServerDeployment	<optional>	GameServerDeployment

GetGameServerDeploymentRolloutCallback(error, responseopt)

Callback as used by getGameServerDeploymentRollout.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.gaming.v1.GameServerDeploymentRollout	<optional>	GameServerDeploymentRollout

ListGameServerDeploymentsCallback(error, responseopt)

Callback as used by listGameServerDeployments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.gaming.v1.ListGameServerDeploymentsResponse	<optional>	ListGameServerDeploymentsResponse

PreviewGameServerDeploymentRolloutCallback(error, responseopt)

Callback as used by previewGameServerDeploymentRollout.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.gaming.v1.PreviewGameServerDeploymentRolloutResponse	<optional>	PreviewGameServerDeploymentRolloutResponse

UpdateGameServerDeploymentCallback(error, responseopt)

Callback as used by updateGameServerDeployment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateGameServerDeploymentRolloutCallback(error, responseopt)

Callback as used by updateGameServerDeploymentRollout.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation