Game Services v1 API - Class GameServerClustersService.GameServerClustersServiceClient (2.1.0)

public class GameServerClustersServiceClient : ClientBase<GameServerClustersService.GameServerClustersServiceClient>

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

Client for GameServerClustersService

Inheritance

Object > ClientBase > ClientBase<GameServerClustersService.GameServerClustersServiceClient> > GameServerClustersService.GameServerClustersServiceClient

Inherited Members

ClientBase<GameServerClustersService.GameServerClustersServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

GameServerClustersServiceClient()

protected GameServerClustersServiceClient()

Protected parameterless constructor to allow creation of test doubles.

GameServerClustersServiceClient(CallInvoker)

public GameServerClustersServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

GameServerClustersServiceClient(ChannelBase)

public GameServerClustersServiceClient(ChannelBase channel)

Creates a new client for GameServerClustersService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

GameServerClustersServiceClient(ClientBase.ClientBaseConfiguration)

protected GameServerClustersServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateGameServerCluster(CreateGameServerClusterRequest, CallOptions)

public virtual Operation CreateGameServerCluster(CreateGameServerClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`CreateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateGameServerCluster(CreateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
Name	Description
`request`	`CreateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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.

CreateGameServerClusterAsync(CreateGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateGameServerClusterAsync(CreateGameServerClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`CreateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

CreateGameServerClusterAsync(CreateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
Name	Description
`request`	`CreateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Operation>`	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
`Operations.OperationsClient`	A new Operations client for the same target as this client.

DeleteGameServerCluster(DeleteGameServerClusterRequest, CallOptions)

public virtual Operation DeleteGameServerCluster(DeleteGameServerClusterRequest request, CallOptions options)

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteGameServerCluster(DeleteGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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.

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteGameServerClusterAsync(DeleteGameServerClusterRequest request, CallOptions options)

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a single game server cluster.

Parameters
Name	Description
`request`	`DeleteGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Operation>`	The call object.

GetGameServerCluster(GetGameServerClusterRequest, CallOptions)

public virtual GameServerCluster GetGameServerCluster(GetGameServerClusterRequest request, CallOptions options)

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`GameServerCluster`	The response received from the server.

GetGameServerCluster(GetGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual GameServerCluster GetGameServerCluster(GetGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`GameServerCluster`	The response received from the server.

GetGameServerClusterAsync(GetGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<GameServerCluster> GetGameServerClusterAsync(GetGameServerClusterRequest request, CallOptions options)

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<GameServerCluster>`	The call object.

GetGameServerClusterAsync(GetGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<GameServerCluster> GetGameServerClusterAsync(GetGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single game server cluster.

Parameters
Name	Description
`request`	`GetGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<GameServerCluster>`	The call object.

ListGameServerClusters(ListGameServerClustersRequest, CallOptions)

public virtual ListGameServerClustersResponse ListGameServerClusters(ListGameServerClustersRequest request, CallOptions options)

Lists game server clusters in a given project and location.

Parameters
Name	Description
`request`	`ListGameServerClustersRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListGameServerClustersResponse`	The response received from the server.

ListGameServerClusters(ListGameServerClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListGameServerClustersResponse ListGameServerClusters(ListGameServerClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists game server clusters in a given project and location.

Parameters
Name	Description
`request`	`ListGameServerClustersRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`ListGameServerClustersResponse`	The response received from the server.

ListGameServerClustersAsync(ListGameServerClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListGameServerClustersResponse> ListGameServerClustersAsync(ListGameServerClustersRequest request, CallOptions options)

Lists game server clusters in a given project and location.

Parameters
Name	Description
`request`	`ListGameServerClustersRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListGameServerClustersResponse>`	The call object.

ListGameServerClustersAsync(ListGameServerClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListGameServerClustersResponse> ListGameServerClustersAsync(ListGameServerClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists game server clusters in a given project and location.

Parameters
Name	Description
`request`	`ListGameServerClustersRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<ListGameServerClustersResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override GameServerClustersService.GameServerClustersServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`GameServerClustersService.GameServerClustersServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Gaming.V1.GameServerClustersService.GameServerClustersServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest, CallOptions)

public virtual PreviewCreateGameServerClusterResponse PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`PreviewCreateGameServerClusterResponse`	The response received from the server.

PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PreviewCreateGameServerClusterResponse PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`PreviewCreateGameServerClusterResponse`	The response received from the server.

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<PreviewCreateGameServerClusterResponse> PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<PreviewCreateGameServerClusterResponse>`	The call object.

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PreviewCreateGameServerClusterResponse> PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`PreviewCreateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<PreviewCreateGameServerClusterResponse>`	The call object.

PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, CallOptions)

public virtual PreviewDeleteGameServerClusterResponse PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request, CallOptions options)

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`PreviewDeleteGameServerClusterResponse`	The response received from the server.

PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PreviewDeleteGameServerClusterResponse PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`PreviewDeleteGameServerClusterResponse`	The response received from the server.

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<PreviewDeleteGameServerClusterResponse> PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest request, CallOptions options)

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<PreviewDeleteGameServerClusterResponse>`	The call object.

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PreviewDeleteGameServerClusterResponse> PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews deletion of a single game server cluster.

Parameters
Name	Description
`request`	`PreviewDeleteGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<PreviewDeleteGameServerClusterResponse>`	The call object.

PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, CallOptions)

public virtual PreviewUpdateGameServerClusterResponse PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request, CallOptions options)

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`PreviewUpdateGameServerClusterResponse`	The response received from the server.

PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PreviewUpdateGameServerClusterResponse PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`PreviewUpdateGameServerClusterResponse`	The response received from the server.

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<PreviewUpdateGameServerClusterResponse> PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest request, CallOptions options)

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<PreviewUpdateGameServerClusterResponse>`	The call object.

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PreviewUpdateGameServerClusterResponse> PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Previews updating a GameServerCluster.

Parameters
Name	Description
`request`	`PreviewUpdateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<PreviewUpdateGameServerClusterResponse>`	The call object.

UpdateGameServerCluster(UpdateGameServerClusterRequest, CallOptions)

public virtual Operation UpdateGameServerCluster(UpdateGameServerClusterRequest request, CallOptions options)

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateGameServerCluster(UpdateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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.

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateGameServerClusterAsync(UpdateGameServerClusterRequest request, CallOptions options)

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Patches a single game server cluster.

Parameters
Name	Description
`request`	`UpdateGameServerClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<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
`AsyncUnaryCall<Operation>`	The call object.