Game Services v1 API - Class GameServerConfigsServiceClientImpl (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 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

Inherited Members

GameServerConfigsServiceClient.DefaultEndpoint

GameServerConfigsServiceClient.DefaultScopes

GameServerConfigsServiceClient.ServiceMetadata

GameServerConfigsServiceClient.CreateAsync(CancellationToken)

GameServerConfigsServiceClient.Create()

GameServerConfigsServiceClient.ShutdownDefaultChannelsAsync()

GameServerConfigsServiceClient.ListGameServerConfigs(string, string, int?, CallSettings)

GameServerConfigsServiceClient.ListGameServerConfigsAsync(string, string, int?, CallSettings)

GameServerConfigsServiceClient.ListGameServerConfigs(GameServerDeploymentName, string, int?, CallSettings)

GameServerConfigsServiceClient.ListGameServerConfigsAsync(GameServerDeploymentName, string, int?, CallSettings)

GameServerConfigsServiceClient.GetGameServerConfigAsync(GetGameServerConfigRequest, CancellationToken)

GameServerConfigsServiceClient.GetGameServerConfig(string, CallSettings)

GameServerConfigsServiceClient.GetGameServerConfigAsync(string, CallSettings)

GameServerConfigsServiceClient.GetGameServerConfigAsync(string, CancellationToken)

GameServerConfigsServiceClient.GetGameServerConfig(GameServerConfigName, CallSettings)

GameServerConfigsServiceClient.GetGameServerConfigAsync(GameServerConfigName, CallSettings)

GameServerConfigsServiceClient.GetGameServerConfigAsync(GameServerConfigName, CancellationToken)

GameServerConfigsServiceClient.CreateGameServerConfigAsync(CreateGameServerConfigRequest, CancellationToken)

GameServerConfigsServiceClient.PollOnceCreateGameServerConfig(string, CallSettings)

GameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(string, CallSettings)

GameServerConfigsServiceClient.CreateGameServerConfig(string, GameServerConfig, CallSettings)

GameServerConfigsServiceClient.CreateGameServerConfigAsync(string, GameServerConfig, CallSettings)

GameServerConfigsServiceClient.CreateGameServerConfigAsync(string, GameServerConfig, CancellationToken)

GameServerConfigsServiceClient.CreateGameServerConfig(GameServerDeploymentName, GameServerConfig, CallSettings)

GameServerConfigsServiceClient.CreateGameServerConfigAsync(GameServerDeploymentName, GameServerConfig, CallSettings)

GameServerConfigsServiceClient.CreateGameServerConfigAsync(GameServerDeploymentName, GameServerConfig, CancellationToken)

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CancellationToken)

GameServerConfigsServiceClient.PollOnceDeleteGameServerConfig(string, CallSettings)

GameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(string, CallSettings)

GameServerConfigsServiceClient.DeleteGameServerConfig(string, CallSettings)

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(string, CallSettings)

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(string, CancellationToken)

GameServerConfigsServiceClient.DeleteGameServerConfig(GameServerConfigName, CallSettings)

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(GameServerConfigName, CallSettings)

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(GameServerConfigName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

Properties

CreateGameServerConfigOperationsClient

public override OperationsClient CreateGameServerConfigOperationsClient { get; }

The long-running operations client for CreateGameServerConfig.

Property Value
Type	Description
OperationsClient

Overrides

GameServerConfigsServiceClient.CreateGameServerConfigOperationsClient

DeleteGameServerConfigOperationsClient

public override OperationsClient DeleteGameServerConfigOperationsClient { get; }

The long-running operations client for DeleteGameServerConfig.

Property Value
Type	Description
OperationsClient

Overrides

GameServerConfigsServiceClient.DeleteGameServerConfigOperationsClient

GrpcClient

public override GameServerConfigsService.GameServerConfigsServiceClient GrpcClient { get; }

The underlying gRPC GameServerConfigsService client

Property Value
Type	Description
GameServerConfigsServiceGameServerConfigsServiceClient

Overrides

GameServerConfigsServiceClient.GrpcClient

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
Name	Description
request	CreateGameServerConfigRequest 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
OperationGameServerConfigOperationMetadata	The RPC response.

Overrides

GameServerConfigsServiceClient.CreateGameServerConfig(CreateGameServerConfigRequest, CallSettings)

CreateGameServerConfigAsync(CreateGameServerConfigRequest, CallSettings)

public override 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
Name	Description
request	CreateGameServerConfigRequest 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
TaskOperationGameServerConfigOperationMetadata	A Task containing the RPC response.

Overrides

GameServerConfigsServiceClient.CreateGameServerConfigAsync(CreateGameServerConfigRequest, CallSettings)

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
Name	Description
request	DeleteGameServerConfigRequest 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

GameServerConfigsServiceClient.DeleteGameServerConfig(DeleteGameServerConfigRequest, CallSettings)

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CallSettings)

public override 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
Name	Description
request	DeleteGameServerConfigRequest 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

GameServerConfigsServiceClient.DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CallSettings)

GetGameServerConfig(GetGameServerConfigRequest, CallSettings)

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

Gets details of a single game server config.

Parameters
Name	Description
request	GetGameServerConfigRequest 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
GameServerConfig	The RPC response.

Overrides

GameServerConfigsServiceClient.GetGameServerConfig(GetGameServerConfigRequest, CallSettings)

GetGameServerConfigAsync(GetGameServerConfigRequest, CallSettings)

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

Gets details of a single game server config.

Parameters
Name	Description
request	GetGameServerConfigRequest 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
TaskGameServerConfig	A Task containing the RPC response.

Overrides

GameServerConfigsServiceClient.GetGameServerConfigAsync(GetGameServerConfigRequest, CallSettings)

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
Name	Description
request	ListGameServerConfigsRequest 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
PagedEnumerableListGameServerConfigsResponseGameServerConfig	A pageable sequence of GameServerConfig resources.

Overrides

GameServerConfigsServiceClient.ListGameServerConfigs(ListGameServerConfigsRequest, CallSettings)

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
Name	Description
request	ListGameServerConfigsRequest 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
PagedAsyncEnumerableListGameServerConfigsResponseGameServerConfig	A pageable asynchronous sequence of GameServerConfig resources.

Overrides

GameServerConfigsServiceClient.ListGameServerConfigsAsync(ListGameServerConfigsRequest, CallSettings)