Game Services v1 API - Class GameServerDeploymentsService.GameServerDeploymentsServiceBase (2.2.0)

[BindServiceMethod(typeof(GameServerDeploymentsService), "BindService")]
public abstract class GameServerDeploymentsService.GameServerDeploymentsServiceBase

Reference documentation and code samples for the Game Services v1 API class GameServerDeploymentsService.GameServerDeploymentsServiceBase.

Base class for server-side implementations of GameServerDeploymentsService

Inheritance

object > GameServerDeploymentsService.GameServerDeploymentsServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Methods

CreateGameServerDeployment(CreateGameServerDeploymentRequest, ServerCallContext)

public virtual Task<Operation> CreateGameServerDeployment(CreateGameServerDeploymentRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`CreateGameServerDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteGameServerDeployment(DeleteGameServerDeploymentRequest, ServerCallContext)

public virtual Task<Operation> DeleteGameServerDeployment(DeleteGameServerDeploymentRequest request, ServerCallContext context)

Deletes a single game server deployment.

Parameters
Name	Description
`request`	`DeleteGameServerDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

FetchDeploymentState(FetchDeploymentStateRequest, ServerCallContext)

public virtual Task<FetchDeploymentStateResponse> FetchDeploymentState(FetchDeploymentStateRequest request, ServerCallContext context)

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	Description
`request`	`FetchDeploymentStateRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskFetchDeploymentStateResponse`	The response to send back to the client (wrapped by a task).

GetGameServerDeployment(GetGameServerDeploymentRequest, ServerCallContext)

public virtual Task<GameServerDeployment> GetGameServerDeployment(GetGameServerDeploymentRequest request, ServerCallContext context)

Gets details of a single game server deployment.

Parameters
Name	Description
`request`	`GetGameServerDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskGameServerDeployment`	The response to send back to the client (wrapped by a task).

GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest, ServerCallContext)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request, ServerCallContext context)

Gets details a single game server deployment rollout.

Parameters
Name	Description
`request`	`GetGameServerDeploymentRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskGameServerDeploymentRollout`	The response to send back to the client (wrapped by a task).

ListGameServerDeployments(ListGameServerDeploymentsRequest, ServerCallContext)

public virtual Task<ListGameServerDeploymentsResponse> ListGameServerDeployments(ListGameServerDeploymentsRequest request, ServerCallContext context)

Lists game server deployments in a given project and location.

Parameters
Name	Description
`request`	`ListGameServerDeploymentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListGameServerDeploymentsResponse`	The response to send back to the client (wrapped by a task).

PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest, ServerCallContext)

public virtual Task<PreviewGameServerDeploymentRolloutResponse> PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`PreviewGameServerDeploymentRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPreviewGameServerDeploymentRolloutResponse`	The response to send back to the client (wrapped by a task).

UpdateGameServerDeployment(UpdateGameServerDeploymentRequest, ServerCallContext)

public virtual Task<Operation> UpdateGameServerDeployment(UpdateGameServerDeploymentRequest request, ServerCallContext context)

Patches a game server deployment.

Parameters
Name	Description
`request`	`UpdateGameServerDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest, ServerCallContext)

public virtual Task<Operation> UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest request, ServerCallContext context)

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	Description
`request`	`UpdateGameServerDeploymentRolloutRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).