Game Services v1 API - Class GameServerConfigsService.GameServerConfigsServiceClient (2.2.0) 

public class GameServerConfigsService.GameServerConfigsServiceClient : ClientBase<GameServerConfigsService.GameServerConfigsServiceClient>

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

Client for GameServerConfigsService

Inheritance

object > ClientBase > ClientBaseGameServerConfigsServiceGameServerConfigsServiceClient > GameServerConfigsService.GameServerConfigsServiceClient

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

GameServerConfigsServiceClient()

protected GameServerConfigsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

GameServerConfigsServiceClient(CallInvoker)

public GameServerConfigsServiceClient(CallInvoker callInvoker)

Creates a new client for GameServerConfigsService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

GameServerConfigsServiceClient(ChannelBase)

public GameServerConfigsServiceClient(ChannelBase channel)

Creates a new client for GameServerConfigsService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

GameServerConfigsServiceClient(ClientBaseConfiguration)

protected GameServerConfigsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateGameServerConfig(CreateGameServerConfigRequest, CallOptions)

public virtual Operation CreateGameServerConfig(CreateGameServerConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateGameServerConfig(CreateGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateGameServerConfig(CreateGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateGameServerConfigAsync(CreateGameServerConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateGameServerConfigAsync(CreateGameServerConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateGameServerConfigAsync(CreateGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateGameServerConfigAsync(CreateGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteGameServerConfig(DeleteGameServerConfigRequest, CallOptions)

public virtual Operation DeleteGameServerConfig(DeleteGameServerConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteGameServerConfig(DeleteGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteGameServerConfig(DeleteGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteGameServerConfigAsync(DeleteGameServerConfigRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteGameServerConfigAsync(DeleteGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetGameServerConfig(GetGameServerConfigRequest, CallOptions)

public virtual GameServerConfig GetGameServerConfig(GetGameServerConfigRequest request, CallOptions options)

Gets details of a single game server config.

Parameters
Name Description
request GetGameServerConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
GameServerConfig

The response received from the server.

GetGameServerConfig(GetGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual GameServerConfig GetGameServerConfig(GetGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single game server config.

Parameters
Name Description
request GetGameServerConfigRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
GameServerConfig

The response received from the server.

GetGameServerConfigAsync(GetGameServerConfigRequest, CallOptions)

public virtual AsyncUnaryCall<GameServerConfig> GetGameServerConfigAsync(GetGameServerConfigRequest request, CallOptions options)

Gets details of a single game server config.

Parameters
Name Description
request GetGameServerConfigRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallGameServerConfig

The call object.

GetGameServerConfigAsync(GetGameServerConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GameServerConfig> GetGameServerConfigAsync(GetGameServerConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single game server config.

Parameters
Name Description
request GetGameServerConfigRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallGameServerConfig

The call object.

ListGameServerConfigs(ListGameServerConfigsRequest, CallOptions)

public virtual ListGameServerConfigsResponse ListGameServerConfigs(ListGameServerConfigsRequest request, CallOptions options)

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

Parameters
Name Description
request ListGameServerConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListGameServerConfigsResponse

The response received from the server.

ListGameServerConfigs(ListGameServerConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListGameServerConfigsResponse ListGameServerConfigs(ListGameServerConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListGameServerConfigsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListGameServerConfigsResponse

The response received from the server.

ListGameServerConfigsAsync(ListGameServerConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListGameServerConfigsResponse> ListGameServerConfigsAsync(ListGameServerConfigsRequest request, CallOptions options)

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

Parameters
Name Description
request ListGameServerConfigsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListGameServerConfigsResponse

The call object.

ListGameServerConfigsAsync(ListGameServerConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListGameServerConfigsResponse> ListGameServerConfigsAsync(ListGameServerConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListGameServerConfigsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListGameServerConfigsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override GameServerConfigsService.GameServerConfigsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
GameServerConfigsServiceGameServerConfigsServiceClient
Overrides