Game Services v1 API - Class GameServerDeploymentsServiceClientImpl (2.2.0) 

public sealed class GameServerDeploymentsServiceClientImpl : GameServerDeploymentsServiceClient

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

GameServerDeploymentsService client wrapper implementation, for convenient use.

Inheritance

object > GameServerDeploymentsServiceClient > GameServerDeploymentsServiceClientImpl

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Remarks

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

Constructors

GameServerDeploymentsServiceClientImpl(GameServerDeploymentsServiceClient, GameServerDeploymentsServiceSettings, ILogger)

public GameServerDeploymentsServiceClientImpl(GameServerDeploymentsService.GameServerDeploymentsServiceClient grpcClient, GameServerDeploymentsServiceSettings settings, ILogger logger)

Constructs a client wrapper for the GameServerDeploymentsService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient GameServerDeploymentsServiceGameServerDeploymentsServiceClient

The underlying gRPC client.
settings GameServerDeploymentsServiceSettings

The base GameServerDeploymentsServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateGameServerDeploymentOperationsClient

public override OperationsClient CreateGameServerDeploymentOperationsClient { get; }

The long-running operations client for CreateGameServerDeployment.

Property Value
Type Description
OperationsClient
Overrides

DeleteGameServerDeploymentOperationsClient

public override OperationsClient DeleteGameServerDeploymentOperationsClient { get; }

The long-running operations client for DeleteGameServerDeployment.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override GameServerDeploymentsService.GameServerDeploymentsServiceClient GrpcClient { get; }

The underlying gRPC GameServerDeploymentsService client

Property Value
Type Description
GameServerDeploymentsServiceGameServerDeploymentsServiceClient
Overrides

UpdateGameServerDeploymentOperationsClient

public override OperationsClient UpdateGameServerDeploymentOperationsClient { get; }

The long-running operations client for UpdateGameServerDeployment.

Property Value
Type Description
OperationsClient
Overrides

UpdateGameServerDeploymentRolloutOperationsClient

public override OperationsClient UpdateGameServerDeploymentRolloutOperationsClient { get; }

The long-running operations client for UpdateGameServerDeploymentRollout.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateGameServerDeployment(CreateGameServerDeploymentRequest, CallSettings)

public override Operation<GameServerDeployment, OperationMetadata> CreateGameServerDeployment(CreateGameServerDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationGameServerDeploymentOperationMetadata

The RPC response.
Overrides

CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CallSettings)

public override Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationGameServerDeploymentOperationMetadata

A Task containing the RPC response.
Overrides

DeleteGameServerDeployment(DeleteGameServerDeploymentRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteGameServerDeployment(DeleteGameServerDeploymentRequest request, CallSettings callSettings = null)

Deletes a single game server deployment.

Parameters
Name Description
request DeleteGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request, CallSettings callSettings = null)

Deletes a single game server deployment.

Parameters
Name Description
request DeleteGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

FetchDeploymentState(FetchDeploymentStateRequest, CallSettings)

public override FetchDeploymentStateResponse FetchDeploymentState(FetchDeploymentStateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FetchDeploymentStateResponse

The RPC response.
Overrides

FetchDeploymentStateAsync(FetchDeploymentStateRequest, CallSettings)

public override Task<FetchDeploymentStateResponse> FetchDeploymentStateAsync(FetchDeploymentStateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFetchDeploymentStateResponse

A Task containing the RPC response.
Overrides

GetGameServerDeployment(GetGameServerDeploymentRequest, CallSettings)

public override GameServerDeployment GetGameServerDeployment(GetGameServerDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
Name Description
request GetGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GameServerDeployment

The RPC response.
Overrides

GetGameServerDeploymentAsync(GetGameServerDeploymentRequest, CallSettings)

public override Task<GameServerDeployment> GetGameServerDeploymentAsync(GetGameServerDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
Name Description
request GetGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGameServerDeployment

A Task containing the RPC response.
Overrides

GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest, CallSettings)

public override GameServerDeploymentRollout GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
Name Description
request GetGameServerDeploymentRolloutRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GameServerDeploymentRollout

The RPC response.
Overrides

GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest, CallSettings)

public override Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
Name Description
request GetGameServerDeploymentRolloutRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGameServerDeploymentRollout

A Task containing the RPC response.
Overrides

ListGameServerDeployments(ListGameServerDeploymentsRequest, CallSettings)

public override PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeployments(ListGameServerDeploymentsRequest request, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
Name Description
request ListGameServerDeploymentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListGameServerDeploymentsResponseGameServerDeployment

A pageable sequence of GameServerDeployment resources.
Overrides

ListGameServerDeploymentsAsync(ListGameServerDeploymentsRequest, CallSettings)

public override PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeploymentsAsync(ListGameServerDeploymentsRequest request, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
Name Description
request ListGameServerDeploymentsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListGameServerDeploymentsResponseGameServerDeployment

A pageable asynchronous sequence of GameServerDeployment resources.
Overrides

PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest, CallSettings)

public override PreviewGameServerDeploymentRolloutResponse PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PreviewGameServerDeploymentRolloutRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PreviewGameServerDeploymentRolloutResponse

The RPC response.
Overrides

PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest, CallSettings)

public override Task<PreviewGameServerDeploymentRolloutResponse> PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request PreviewGameServerDeploymentRolloutRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPreviewGameServerDeploymentRolloutResponse

A Task containing the RPC response.
Overrides

UpdateGameServerDeployment(UpdateGameServerDeploymentRequest, CallSettings)

public override Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeployment(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
Name Description
request UpdateGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationGameServerDeploymentOperationMetadata

The RPC response.
Overrides

UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CallSettings)

public override Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
Name Description
request UpdateGameServerDeploymentRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationGameServerDeploymentOperationMetadata

A Task containing the RPC response.
Overrides

UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest, CallSettings)

public override Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationGameServerDeploymentOperationMetadata

The RPC response.
Overrides

UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CallSettings)

public override Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationGameServerDeploymentOperationMetadata

A Task containing the RPC response.
Overrides