Class GameServerDeploymentsServiceClientImpl (2.0.0-beta01)

public sealed class GameServerDeploymentsServiceClientImpl : GameServerDeploymentsServiceClient

GameServerDeploymentsService client wrapper implementation, for convenient use.

Inheritance

Object > GameServerDeploymentsServiceClient > GameServerDeploymentsServiceClientImpl

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.dll

Remarks

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

Constructors

GameServerDeploymentsServiceClientImpl(GameServerDeploymentsService.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
NameDescription
grpcClientGameServerDeploymentsService.GameServerDeploymentsServiceClient

The underlying gRPC client.

settingsGameServerDeploymentsServiceSettings

The base GameServerDeploymentsServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateGameServerDeploymentOperationsClient

public override OperationsClient CreateGameServerDeploymentOperationsClient { get; }

The long-running operations client for CreateGameServerDeployment.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteGameServerDeploymentOperationsClient

public override OperationsClient DeleteGameServerDeploymentOperationsClient { get; }

The long-running operations client for DeleteGameServerDeployment.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override GameServerDeploymentsService.GameServerDeploymentsServiceClient GrpcClient { get; }

The underlying gRPC GameServerDeploymentsService client

Property Value
TypeDescription
GameServerDeploymentsService.GameServerDeploymentsServiceClient
Overrides

UpdateGameServerDeploymentOperationsClient

public override OperationsClient UpdateGameServerDeploymentOperationsClient { get; }

The long-running operations client for UpdateGameServerDeployment.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateGameServerDeploymentRolloutOperationsClient

public override OperationsClient UpdateGameServerDeploymentRolloutOperationsClient { get; }

The long-running operations client for UpdateGameServerDeploymentRollout.

Property Value
TypeDescription
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
NameDescription
requestCreateGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Overrides

CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CallSettings)

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

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

Parameters
NameDescription
requestCreateGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

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
NameDescription
requestDeleteGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Overrides

DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CallSettings)

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

Deletes a single game server deployment.

Parameters
NameDescription
requestDeleteGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

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
NameDescription
requestFetchDeploymentStateRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestFetchDeploymentStateRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FetchDeploymentStateResponse>

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
NameDescription
requestGetGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeployment>

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
NameDescription
requestGetGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGetGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

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
NameDescription
requestListGameServerDeploymentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment>

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
NameDescription
requestListGameServerDeploymentsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment>

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
NameDescription
requestPreviewGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPreviewGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PreviewGameServerDeploymentRolloutResponse>

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
NameDescription
requestUpdateGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Overrides

UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CallSettings)

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

Patches a game server deployment.

Parameters
NameDescription
requestUpdateGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

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
NameDescription
requestUpdateGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Overrides

UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CallSettings)

public override async 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
NameDescription
requestUpdateGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Overrides