Google Cloud for Games v1beta API - Class GameServerClustersService.GameServerClustersServiceClient (2.0.0-beta03)

Version latest

• 2.0.0-beta03 (latest)
• 2.0.0-beta02
• 1.0.0-beta09

public class GameServerClustersService.GameServerClustersServiceClient : ClientBase<GameServerClustersService.GameServerClustersServiceClient>

Reference documentation and code samples for the Google Cloud for Games v1beta API class GameServerClustersService.GameServerClustersServiceClient.

Client for GameServerClustersService

Inheritance

object > ClientBase > ClientBaseGameServerClustersServiceGameServerClustersServiceClient > GameServerClustersService.GameServerClustersServiceClient

Inherited Members

ClientBase<GameServerClustersService.GameServerClustersServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.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(ClientBaseConfiguration)

protected GameServerClustersServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallOperation	The call object.

CreateGameServerClusterAsync(CreateGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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

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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallOperation	The call object.

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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

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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallGameServerCluster	The call object.

GetGameServerClusterAsync(GetGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallGameServerCluster	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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallListGameServerClustersResponse	The call object.

ListGameServerClustersAsync(ListGameServerClustersRequest, Metadata, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallListGameServerClustersResponse	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
GameServerClustersServiceGameServerClustersServiceClient

Overrides

ClientBase<GameServerClustersService.GameServerClustersServiceClient>.NewInstance(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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewCreateGameServerClusterResponse	The call object.

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewCreateGameServerClusterResponse	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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewDeleteGameServerClusterResponse	The call object.

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewDeleteGameServerClusterResponse	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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewUpdateGameServerClusterResponse	The call object.

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallPreviewUpdateGameServerClusterResponse	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, DateTime?, CancellationToken)

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

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	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
AsyncUnaryCallOperation	The call object.

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, Metadata, DateTime?, CancellationToken)

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

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