public sealed class GameServerDeploymentsServiceClientImpl : GameServerDeploymentsServiceClientGameServerDeploymentsService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Gaming.V1Assembly
Google.Cloud.Gaming.V1.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 | |
|---|---|
| Name | Description |
grpcClient |
GameServerDeploymentsService.GameServerDeploymentsServiceClientThe underlying gRPC client. |
settings |
GameServerDeploymentsServiceSettingsThe base GameServerDeploymentsServiceSettings used within this client. |
logger |
ILoggerOptional 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 |
|
DeleteGameServerDeploymentOperationsClient
public override OperationsClient DeleteGameServerDeploymentOperationsClient { get; }The long-running operations client for DeleteGameServerDeployment.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override GameServerDeploymentsService.GameServerDeploymentsServiceClient GrpcClient { get; }The underlying gRPC GameServerDeploymentsService client
| Property Value | |
|---|---|
| Type | Description |
GameServerDeploymentsService.GameServerDeploymentsServiceClient |
|
UpdateGameServerDeploymentOperationsClient
public override OperationsClient UpdateGameServerDeploymentOperationsClient { get; }The long-running operations client for UpdateGameServerDeployment.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
UpdateGameServerDeploymentRolloutOperationsClient
public override OperationsClient UpdateGameServerDeploymentRolloutOperationsClient { get; }The long-running operations client for UpdateGameServerDeploymentRollout.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
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 |
CreateGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<GameServerDeployment, OperationMetadata> |
The RPC response. |
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 | |
|---|---|
| Name | Description |
request |
CreateGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<GameServerDeployment, OperationMetadata>> |
A Task containing the RPC response. |
DeleteGameServerDeployment(DeleteGameServerDeploymentRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteGameServerDeployment(DeleteGameServerDeploymentRequest request, CallSettings callSettings = null)Deletes a single game server deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, OperationMetadata> |
The RPC response. |
DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request, CallSettings callSettings = null)Deletes a single game server deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, OperationMetadata>> |
A Task containing the RPC response. |
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 |
FetchDeploymentStateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
FetchDeploymentStateResponse |
The RPC response. |
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 |
FetchDeploymentStateRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<FetchDeploymentStateResponse> |
A Task containing the RPC response. |
GetGameServerDeployment(GetGameServerDeploymentRequest, CallSettings)
public override GameServerDeployment GetGameServerDeployment(GetGameServerDeploymentRequest request, CallSettings callSettings = null)Gets details of a single game server deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GameServerDeployment |
The RPC response. |
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 |
GetGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<GameServerDeployment> |
A Task containing the RPC response. |
GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest, CallSettings)
public override GameServerDeploymentRollout GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)Gets details a single game server deployment rollout.
| Parameters | |
|---|---|
| Name | Description |
request |
GetGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GameServerDeploymentRollout |
The RPC response. |
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 |
GetGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<GameServerDeploymentRollout> |
A Task containing the RPC response. |
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 |
ListGameServerDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> |
A pageable sequence of GameServerDeployment resources. |
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 |
ListGameServerDeploymentsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> |
A pageable asynchronous sequence of GameServerDeployment resources. |
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 |
PreviewGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PreviewGameServerDeploymentRolloutResponse |
The RPC response. |
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 |
PreviewGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<PreviewGameServerDeploymentRolloutResponse> |
A Task containing the RPC response. |
UpdateGameServerDeployment(UpdateGameServerDeploymentRequest, CallSettings)
public override Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeployment(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)Patches a game server deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<GameServerDeployment, OperationMetadata> |
The RPC response. |
UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CallSettings)
public override async Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)Patches a game server deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateGameServerDeploymentRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<GameServerDeployment, OperationMetadata>> |
A Task containing the RPC response. |
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 |
UpdateGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<GameServerDeployment, OperationMetadata> |
The RPC response. |
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 | |
|---|---|
| Name | Description |
request |
UpdateGameServerDeploymentRolloutRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<GameServerDeployment, OperationMetadata>> |
A Task containing the RPC response. |