Game Services v1 API - Class GameServerClustersServiceClientImpl (2.2.0)

public sealed class GameServerClustersServiceClientImpl : GameServerClustersServiceClient

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

GameServerClustersService client wrapper implementation, for convenient use.

Inheritance

object > GameServerClustersServiceClient > GameServerClustersServiceClientImpl

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Remarks

The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Constructors

GameServerClustersServiceClientImpl(GameServerClustersServiceClient, GameServerClustersServiceSettings, ILogger)

public GameServerClustersServiceClientImpl(GameServerClustersService.GameServerClustersServiceClient grpcClient, GameServerClustersServiceSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientGameServerClustersServiceGameServerClustersServiceClient

The underlying gRPC client.

settingsGameServerClustersServiceSettings

The base GameServerClustersServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateGameServerClusterOperationsClient

public override OperationsClient CreateGameServerClusterOperationsClient { get; }

The long-running operations client for CreateGameServerCluster.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteGameServerClusterOperationsClient

public override OperationsClient DeleteGameServerClusterOperationsClient { get; }

The long-running operations client for DeleteGameServerCluster.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override GameServerClustersService.GameServerClustersServiceClient GrpcClient { get; }

The underlying gRPC GameServerClustersService client

Property Value
TypeDescription
GameServerClustersServiceGameServerClustersServiceClient
Overrides

UpdateGameServerClusterOperationsClient

public override OperationsClient UpdateGameServerClusterOperationsClient { get; }

The long-running operations client for UpdateGameServerCluster.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateGameServerCluster(CreateGameServerClusterRequest, CallSettings)

public override Operation<GameServerCluster, OperationMetadata> CreateGameServerCluster(CreateGameServerClusterRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationGameServerClusterOperationMetadata

The RPC response.

Overrides

CreateGameServerClusterAsync(CreateGameServerClusterRequest, CallSettings)

public override Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(CreateGameServerClusterRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationGameServerClusterOperationMetadata

A Task containing the RPC response.

Overrides

DeleteGameServerCluster(DeleteGameServerClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteGameServerCluster(DeleteGameServerClusterRequest request, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
NameDescription
requestDeleteGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CallSettings)

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

Deletes a single game server cluster.

Parameters
NameDescription
requestDeleteGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

GetGameServerCluster(GetGameServerClusterRequest, CallSettings)

public override GameServerCluster GetGameServerCluster(GetGameServerClusterRequest request, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
NameDescription
requestGetGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerCluster

The RPC response.

Overrides

GetGameServerClusterAsync(GetGameServerClusterRequest, CallSettings)

public override Task<GameServerCluster> GetGameServerClusterAsync(GetGameServerClusterRequest request, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
NameDescription
requestGetGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskGameServerCluster

A Task containing the RPC response.

Overrides

ListGameServerClusters(ListGameServerClustersRequest, CallSettings)

public override PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClusters(ListGameServerClustersRequest request, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
NameDescription
requestListGameServerClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListGameServerClustersResponseGameServerCluster

A pageable sequence of GameServerCluster resources.

Overrides

ListGameServerClustersAsync(ListGameServerClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClustersAsync(ListGameServerClustersRequest request, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
NameDescription
requestListGameServerClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListGameServerClustersResponseGameServerCluster

A pageable asynchronous sequence of GameServerCluster resources.

Overrides

PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest, CallSettings)

public override PreviewCreateGameServerClusterResponse PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request, CallSettings callSettings = null)

Previews creation of a new game server cluster in a given project and location.

Parameters
NameDescription
requestPreviewCreateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PreviewCreateGameServerClusterResponse

The RPC response.

Overrides

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CallSettings)

public override Task<PreviewCreateGameServerClusterResponse> PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest request, CallSettings callSettings = null)

Previews creation of a new game server cluster in a given project and location.

Parameters
NameDescription
requestPreviewCreateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreviewCreateGameServerClusterResponse

A Task containing the RPC response.

Overrides

PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, CallSettings)

public override PreviewDeleteGameServerClusterResponse PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request, CallSettings callSettings = null)

Previews deletion of a single game server cluster.

Parameters
NameDescription
requestPreviewDeleteGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PreviewDeleteGameServerClusterResponse

The RPC response.

Overrides

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CallSettings)

public override Task<PreviewDeleteGameServerClusterResponse> PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest request, CallSettings callSettings = null)

Previews deletion of a single game server cluster.

Parameters
NameDescription
requestPreviewDeleteGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreviewDeleteGameServerClusterResponse

A Task containing the RPC response.

Overrides

PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, CallSettings)

public override PreviewUpdateGameServerClusterResponse PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request, CallSettings callSettings = null)

Previews updating a GameServerCluster.

Parameters
NameDescription
requestPreviewUpdateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PreviewUpdateGameServerClusterResponse

The RPC response.

Overrides

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CallSettings)

public override Task<PreviewUpdateGameServerClusterResponse> PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest request, CallSettings callSettings = null)

Previews updating a GameServerCluster.

Parameters
NameDescription
requestPreviewUpdateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPreviewUpdateGameServerClusterResponse

A Task containing the RPC response.

Overrides

UpdateGameServerCluster(UpdateGameServerClusterRequest, CallSettings)

public override Operation<GameServerCluster, OperationMetadata> UpdateGameServerCluster(UpdateGameServerClusterRequest request, CallSettings callSettings = null)

Patches a single game server cluster.

Parameters
NameDescription
requestUpdateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationGameServerClusterOperationMetadata

The RPC response.

Overrides

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CallSettings)

public override Task<Operation<GameServerCluster, OperationMetadata>> UpdateGameServerClusterAsync(UpdateGameServerClusterRequest request, CallSettings callSettings = null)

Patches a single game server cluster.

Parameters
NameDescription
requestUpdateGameServerClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationGameServerClusterOperationMetadata

A Task containing the RPC response.

Overrides