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

Inherited Members

GameServerClustersServiceClient.DefaultEndpoint

GameServerClustersServiceClient.DefaultScopes

GameServerClustersServiceClient.ServiceMetadata

GameServerClustersServiceClient.CreateAsync(CancellationToken)

GameServerClustersServiceClient.Create()

GameServerClustersServiceClient.ShutdownDefaultChannelsAsync()

GameServerClustersServiceClient.ListGameServerClusters(string, string, int?, CallSettings)

GameServerClustersServiceClient.ListGameServerClustersAsync(string, string, int?, CallSettings)

GameServerClustersServiceClient.ListGameServerClusters(RealmName, string, int?, CallSettings)

GameServerClustersServiceClient.ListGameServerClustersAsync(RealmName, string, int?, CallSettings)

GameServerClustersServiceClient.GetGameServerClusterAsync(GetGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.GetGameServerCluster(string, CallSettings)

GameServerClustersServiceClient.GetGameServerClusterAsync(string, CallSettings)

GameServerClustersServiceClient.GetGameServerClusterAsync(string, CancellationToken)

GameServerClustersServiceClient.GetGameServerCluster(GameServerClusterName, CallSettings)

GameServerClustersServiceClient.GetGameServerClusterAsync(GameServerClusterName, CallSettings)

GameServerClustersServiceClient.GetGameServerClusterAsync(GameServerClusterName, CancellationToken)

GameServerClustersServiceClient.CreateGameServerClusterAsync(CreateGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.PollOnceCreateGameServerCluster(string, CallSettings)

GameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(string, CallSettings)

GameServerClustersServiceClient.CreateGameServerCluster(string, GameServerCluster, string, CallSettings)

GameServerClustersServiceClient.CreateGameServerClusterAsync(string, GameServerCluster, string, CallSettings)

GameServerClustersServiceClient.CreateGameServerClusterAsync(string, GameServerCluster, string, CancellationToken)

GameServerClustersServiceClient.CreateGameServerCluster(RealmName, GameServerCluster, string, CallSettings)

GameServerClustersServiceClient.CreateGameServerClusterAsync(RealmName, GameServerCluster, string, CallSettings)

GameServerClustersServiceClient.CreateGameServerClusterAsync(RealmName, GameServerCluster, string, CancellationToken)

GameServerClustersServiceClient.PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.PollOnceDeleteGameServerCluster(string, CallSettings)

GameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(string, CallSettings)

GameServerClustersServiceClient.DeleteGameServerCluster(string, CallSettings)

GameServerClustersServiceClient.DeleteGameServerClusterAsync(string, CallSettings)

GameServerClustersServiceClient.DeleteGameServerClusterAsync(string, CancellationToken)

GameServerClustersServiceClient.DeleteGameServerCluster(GameServerClusterName, CallSettings)

GameServerClustersServiceClient.DeleteGameServerClusterAsync(GameServerClusterName, CallSettings)

GameServerClustersServiceClient.DeleteGameServerClusterAsync(GameServerClusterName, CancellationToken)

GameServerClustersServiceClient.PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CancellationToken)

GameServerClustersServiceClient.PollOnceUpdateGameServerCluster(string, CallSettings)

GameServerClustersServiceClient.PollOnceUpdateGameServerClusterAsync(string, CallSettings)

GameServerClustersServiceClient.UpdateGameServerCluster(GameServerCluster, FieldMask, CallSettings)

GameServerClustersServiceClient.UpdateGameServerClusterAsync(GameServerCluster, FieldMask, CallSettings)

GameServerClustersServiceClient.UpdateGameServerClusterAsync(GameServerCluster, FieldMask, CancellationToken)

GameServerClustersServiceClient.PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
`grpcClient`	`GameServerClustersServiceGameServerClustersServiceClient` The underlying gRPC client.
`settings`	`GameServerClustersServiceSettings` The base GameServerClustersServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

CreateGameServerClusterOperationsClient

public override OperationsClient CreateGameServerClusterOperationsClient { get; }

The long-running operations client for CreateGameServerCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

GameServerClustersServiceClient.CreateGameServerClusterOperationsClient

DeleteGameServerClusterOperationsClient

public override OperationsClient DeleteGameServerClusterOperationsClient { get; }

The long-running operations client for DeleteGameServerCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

GameServerClustersServiceClient.DeleteGameServerClusterOperationsClient

GrpcClient

public override GameServerClustersService.GameServerClustersServiceClient GrpcClient { get; }

The underlying gRPC GameServerClustersService client

Property Value
Type	Description
`GameServerClustersServiceGameServerClustersServiceClient`

Overrides

GameServerClustersServiceClient.GrpcClient

UpdateGameServerClusterOperationsClient

public override OperationsClient UpdateGameServerClusterOperationsClient { get; }

The long-running operations client for UpdateGameServerCluster.

Property Value
Type	Description
`OperationsClient`

Overrides

GameServerClustersServiceClient.UpdateGameServerClusterOperationsClient

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
Name	Description
`request`	`CreateGameServerClusterRequest` 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
`OperationGameServerClusterOperationMetadata`	The RPC response.

Overrides

GameServerClustersServiceClient.CreateGameServerCluster(CreateGameServerClusterRequest, CallSettings)

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
Name	Description
`request`	`CreateGameServerClusterRequest` 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
`TaskOperationGameServerClusterOperationMetadata`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.CreateGameServerClusterAsync(CreateGameServerClusterRequest, CallSettings)

DeleteGameServerCluster(DeleteGameServerClusterRequest, CallSettings)

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

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` 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

GameServerClustersServiceClient.DeleteGameServerCluster(DeleteGameServerClusterRequest, CallSettings)

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CallSettings)

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

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` 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

GameServerClustersServiceClient.DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CallSettings)

GetGameServerCluster(GetGameServerClusterRequest, CallSettings)

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

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` 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
`GameServerCluster`	The RPC response.

Overrides

GameServerClustersServiceClient.GetGameServerCluster(GetGameServerClusterRequest, CallSettings)

GetGameServerClusterAsync(GetGameServerClusterRequest, CallSettings)

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

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` 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
`TaskGameServerCluster`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.GetGameServerClusterAsync(GetGameServerClusterRequest, CallSettings)

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
Name	Description
`request`	`ListGameServerClustersRequest` 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
`PagedEnumerableListGameServerClustersResponseGameServerCluster`	A pageable sequence of GameServerCluster resources.

Overrides

GameServerClustersServiceClient.ListGameServerClusters(ListGameServerClustersRequest, CallSettings)

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
Name	Description
`request`	`ListGameServerClustersRequest` 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
`PagedAsyncEnumerableListGameServerClustersResponseGameServerCluster`	A pageable asynchronous sequence of GameServerCluster resources.

Overrides

GameServerClustersServiceClient.ListGameServerClustersAsync(ListGameServerClustersRequest, CallSettings)

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
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` 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
`PreviewCreateGameServerClusterResponse`	The RPC response.

Overrides

GameServerClustersServiceClient.PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest, CallSettings)

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
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` 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
`TaskPreviewCreateGameServerClusterResponse`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CallSettings)

PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, CallSettings)

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

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` 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
`PreviewDeleteGameServerClusterResponse`	The RPC response.

Overrides

GameServerClustersServiceClient.PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, CallSettings)

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CallSettings)

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

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` 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
`TaskPreviewDeleteGameServerClusterResponse`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CallSettings)

PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, CallSettings)

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

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` 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
`PreviewUpdateGameServerClusterResponse`	The RPC response.

Overrides

GameServerClustersServiceClient.PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, CallSettings)

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CallSettings)

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

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` 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
`TaskPreviewUpdateGameServerClusterResponse`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CallSettings)

UpdateGameServerCluster(UpdateGameServerClusterRequest, CallSettings)

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

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` 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
`OperationGameServerClusterOperationMetadata`	The RPC response.

Overrides

GameServerClustersServiceClient.UpdateGameServerCluster(UpdateGameServerClusterRequest, CallSettings)

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CallSettings)

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

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` 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
`TaskOperationGameServerClusterOperationMetadata`	A Task containing the RPC response.

Overrides

GameServerClustersServiceClient.UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CallSettings)