Game Services v1 API - Class GameServerConfigsServiceClientImpl (2.1.0)

public sealed class GameServerConfigsServiceClientImpl : GameServerConfigsServiceClient

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

GameServerConfigsService client wrapper implementation, for convenient use.

Inheritance

Object > GameServerConfigsServiceClient > GameServerConfigsServiceClientImpl

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Remarks

The game server config configures the game servers in an Agones fleet.

Constructors

GameServerConfigsServiceClientImpl(GameServerConfigsService.GameServerConfigsServiceClient, GameServerConfigsServiceSettings, ILogger)

public GameServerConfigsServiceClientImpl(GameServerConfigsService.GameServerConfigsServiceClient grpcClient, GameServerConfigsServiceSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientGameServerConfigsService.GameServerConfigsServiceClient

The underlying gRPC client.

settingsGameServerConfigsServiceSettings

The base GameServerConfigsServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateGameServerConfigOperationsClient

public override OperationsClient CreateGameServerConfigOperationsClient { get; }

The long-running operations client for CreateGameServerConfig.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteGameServerConfigOperationsClient

public override OperationsClient DeleteGameServerConfigOperationsClient { get; }

The long-running operations client for DeleteGameServerConfig.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override GameServerConfigsService.GameServerConfigsServiceClient GrpcClient { get; }

The underlying gRPC GameServerConfigsService client

Property Value
TypeDescription
GameServerConfigsService.GameServerConfigsServiceClient
Overrides

Methods

CreateGameServerConfig(CreateGameServerConfigRequest, CallSettings)

public override Operation<GameServerConfig, OperationMetadata> CreateGameServerConfig(CreateGameServerConfigRequest request, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
requestCreateGameServerConfigRequest

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<GameServerConfig, OperationMetadata>

The RPC response.

Overrides

CreateGameServerConfigAsync(CreateGameServerConfigRequest, CallSettings)

public override async Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(CreateGameServerConfigRequest request, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
requestCreateGameServerConfigRequest

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<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Overrides

DeleteGameServerConfig(DeleteGameServerConfigRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteGameServerConfig(DeleteGameServerConfigRequest request, CallSettings callSettings = null)

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
requestDeleteGameServerConfigRequest

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

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CallSettings)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
requestDeleteGameServerConfigRequest

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

GetGameServerConfig(GetGameServerConfigRequest, CallSettings)

public override GameServerConfig GetGameServerConfig(GetGameServerConfigRequest request, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
requestGetGameServerConfigRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerConfig

The RPC response.

Overrides

GetGameServerConfigAsync(GetGameServerConfigRequest, CallSettings)

public override Task<GameServerConfig> GetGameServerConfigAsync(GetGameServerConfigRequest request, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
requestGetGameServerConfigRequest

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<GameServerConfig>

A Task containing the RPC response.

Overrides

ListGameServerConfigs(ListGameServerConfigsRequest, CallSettings)

public override PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigs(ListGameServerConfigsRequest request, CallSettings callSettings = null)

Lists game server configs in a given project, location, and game server deployment.

Parameters
NameDescription
requestListGameServerConfigsRequest

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<ListGameServerConfigsResponse, GameServerConfig>

A pageable sequence of GameServerConfig resources.

Overrides

ListGameServerConfigsAsync(ListGameServerConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigsAsync(ListGameServerConfigsRequest request, CallSettings callSettings = null)

Lists game server configs in a given project, location, and game server deployment.

Parameters
NameDescription
requestListGameServerConfigsRequest

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<ListGameServerConfigsResponse, GameServerConfig>

A pageable asynchronous sequence of GameServerConfig resources.

Overrides