Game Services v1 API - Class GameServerDeploymentsServiceClientImpl (2.2.0)

Version latest

• 2.2.0 (latest)
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.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

Inherited Members

GameServerDeploymentsServiceClient.DefaultEndpoint

GameServerDeploymentsServiceClient.DefaultScopes

GameServerDeploymentsServiceClient.ServiceMetadata

GameServerDeploymentsServiceClient.CreateAsync(CancellationToken)

GameServerDeploymentsServiceClient.Create()

GameServerDeploymentsServiceClient.ShutdownDefaultChannelsAsync()

GameServerDeploymentsServiceClient.ListGameServerDeployments(string, string, int?, CallSettings)

GameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(string, string, int?, CallSettings)

GameServerDeploymentsServiceClient.ListGameServerDeployments(LocationName, string, int?, CallSettings)

GameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(LocationName, string, int?, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(GetGameServerDeploymentRequest, CancellationToken)

GameServerDeploymentsServiceClient.GetGameServerDeployment(string, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(string, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(string, CancellationToken)

GameServerDeploymentsServiceClient.GetGameServerDeployment(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(GameServerDeploymentName, CancellationToken)

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CancellationToken)

GameServerDeploymentsServiceClient.PollOnceCreateGameServerDeployment(string, CallSettings)

GameServerDeploymentsServiceClient.PollOnceCreateGameServerDeploymentAsync(string, CallSettings)

GameServerDeploymentsServiceClient.CreateGameServerDeployment(string, GameServerDeployment, CallSettings)

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(string, GameServerDeployment, CallSettings)

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(string, GameServerDeployment, CancellationToken)

GameServerDeploymentsServiceClient.CreateGameServerDeployment(LocationName, GameServerDeployment, CallSettings)

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(LocationName, GameServerDeployment, CallSettings)

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(LocationName, GameServerDeployment, CancellationToken)

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CancellationToken)

GameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeployment(string, CallSettings)

GameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(string, CallSettings)

GameServerDeploymentsServiceClient.DeleteGameServerDeployment(string, CallSettings)

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(string, CallSettings)

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(string, CancellationToken)

GameServerDeploymentsServiceClient.DeleteGameServerDeployment(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(GameServerDeploymentName, CancellationToken)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CancellationToken)

GameServerDeploymentsServiceClient.PollOnceUpdateGameServerDeployment(string, CallSettings)

GameServerDeploymentsServiceClient.PollOnceUpdateGameServerDeploymentAsync(string, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeployment(GameServerDeployment, FieldMask, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(GameServerDeployment, FieldMask, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(GameServerDeployment, FieldMask, CancellationToken)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest, CancellationToken)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(string, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(string, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(string, CancellationToken)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(GameServerDeploymentName, CallSettings)

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(GameServerDeploymentName, CancellationToken)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CancellationToken)

GameServerDeploymentsServiceClient.PollOnceUpdateGameServerDeploymentRollout(string, CallSettings)

GameServerDeploymentsServiceClient.PollOnceUpdateGameServerDeploymentRolloutAsync(string, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRollout(GameServerDeploymentRollout, FieldMask, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout, FieldMask, CallSettings)

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout, FieldMask, CancellationToken)

GameServerDeploymentsServiceClient.PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest, CancellationToken)

GameServerDeploymentsServiceClient.FetchDeploymentStateAsync(FetchDeploymentStateRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

GameServerDeploymentsServiceClient.CreateGameServerDeploymentOperationsClient

DeleteGameServerDeploymentOperationsClient

public override OperationsClient DeleteGameServerDeploymentOperationsClient { get; }

The long-running operations client for DeleteGameServerDeployment.

Property Value
Type	Description
OperationsClient

Overrides

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentOperationsClient

GrpcClient

public override GameServerDeploymentsService.GameServerDeploymentsServiceClient GrpcClient { get; }

The underlying gRPC GameServerDeploymentsService client

Property Value
Type	Description
GameServerDeploymentsServiceGameServerDeploymentsServiceClient

Overrides

GameServerDeploymentsServiceClient.GrpcClient

UpdateGameServerDeploymentOperationsClient

public override OperationsClient UpdateGameServerDeploymentOperationsClient { get; }

The long-running operations client for UpdateGameServerDeployment.

Property Value
Type	Description
OperationsClient

Overrides

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentOperationsClient

UpdateGameServerDeploymentRolloutOperationsClient

public override OperationsClient UpdateGameServerDeploymentRolloutOperationsClient { get; }

The long-running operations client for UpdateGameServerDeploymentRollout.

Property Value
Type	Description
OperationsClient

Overrides

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutOperationsClient

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

GameServerDeploymentsServiceClient.CreateGameServerDeployment(CreateGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.DeleteGameServerDeployment(DeleteGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.FetchDeploymentState(FetchDeploymentStateRequest, CallSettings)

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

GameServerDeploymentsServiceClient.FetchDeploymentStateAsync(FetchDeploymentStateRequest, CallSettings)

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

GameServerDeploymentsServiceClient.GetGameServerDeployment(GetGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(GetGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest, CallSettings)

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

GameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest, CallSettings)

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

GameServerDeploymentsServiceClient.ListGameServerDeployments(ListGameServerDeploymentsRequest, CallSettings)

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

GameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(ListGameServerDeploymentsRequest, CallSettings)

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

GameServerDeploymentsServiceClient.PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest, CallSettings)

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

GameServerDeploymentsServiceClient.PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest, CallSettings)

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

GameServerDeploymentsServiceClient.UpdateGameServerDeployment(UpdateGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CallSettings)

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

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest, CallSettings)

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

GameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CallSettings)