Game Services v1 API - Class GameServerClustersServiceClient (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 abstract class GameServerClustersServiceClient

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

GameServerClustersService client wrapper, for convenient use.

Inheritance

object > GameServerClustersServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

GameServerClustersServiceClientImpl

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Remarks

The game server cluster maps to Kubernetes clusters running Agones and is used to manage fleets within clusters.

Properties

CreateGameServerClusterOperationsClient

public virtual OperationsClient CreateGameServerClusterOperationsClient { get; }

The long-running operations client for CreateGameServerCluster.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the GameServerClustersService service, which is a host of "gameservices.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default GameServerClustersService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default GameServerClustersService scopes are:

• https://www.googleapis.com/auth/cloud-platform

DeleteGameServerClusterOperationsClient

public virtual OperationsClient DeleteGameServerClusterOperationsClient { get; }

The long-running operations client for DeleteGameServerCluster.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual GameServerClustersService.GameServerClustersServiceClient GrpcClient { get; }

The underlying gRPC GameServerClustersService client

Property Value
Type	Description
GameServerClustersServiceGameServerClustersServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

UpdateGameServerClusterOperationsClient

public virtual OperationsClient UpdateGameServerClusterOperationsClient { get; }

The long-running operations client for UpdateGameServerCluster.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static GameServerClustersServiceClient Create()

Synchronously creates a GameServerClustersServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GameServerClustersServiceClientBuilder.

Returns
Type	Description
GameServerClustersServiceClient	The created GameServerClustersServiceClient.

CreateAsync(CancellationToken)

public static Task<GameServerClustersServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a GameServerClustersServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use GameServerClustersServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskGameServerClustersServiceClient	The task representing the created GameServerClustersServiceClient.

CreateGameServerCluster(CreateGameServerClusterRequest, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> CreateGameServerCluster(CreateGameServerClusterRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
CreateGameServerClusterRequest request = new CreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = gameServerClustersServiceClient.CreateGameServerCluster(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceCreateGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerCluster(RealmName, GameServerCluster, string, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> CreateGameServerCluster(RealmName parent, GameServerCluster gameServerCluster, string gameServerClusterId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	RealmName Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationGameServerClusterOperationMetadata	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
RealmName parent = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]");
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = gameServerClustersServiceClient.CreateGameServerCluster(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceCreateGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerCluster(string, GameServerCluster, string, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> CreateGameServerCluster(string parent, GameServerCluster gameServerCluster, string gameServerClusterId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationGameServerClusterOperationMetadata	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]";
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = gameServerClustersServiceClient.CreateGameServerCluster(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceCreateGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(CreateGameServerClusterRequest, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(CreateGameServerClusterRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerClusterRequest request = new CreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(CreateGameServerClusterRequest, CancellationToken)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(CreateGameServerClusterRequest request, CancellationToken cancellationToken)

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

Parameters
Name	Description
request	CreateGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerClusterRequest request = new CreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(RealmName, GameServerCluster, string, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(RealmName parent, GameServerCluster gameServerCluster, string gameServerClusterId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	RealmName Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
RealmName parent = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]");
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(RealmName, GameServerCluster, string, CancellationToken)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(RealmName parent, GameServerCluster gameServerCluster, string gameServerClusterId, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	RealmName Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
RealmName parent = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]");
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(string, GameServerCluster, string, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(string parent, GameServerCluster gameServerCluster, string gameServerClusterId, CallSettings callSettings = null)

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

Parameters
Name	Description
parent	string Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]";
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

CreateGameServerClusterAsync(string, GameServerCluster, string, CancellationToken)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> CreateGameServerClusterAsync(string parent, GameServerCluster gameServerCluster, string gameServerClusterId, CancellationToken cancellationToken)

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

Parameters
Name	Description
parent	string Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm-id}.
gameServerCluster	GameServerCluster Required. The game server cluster resource to be created.
gameServerClusterId	string Required. The ID of the game server cluster resource to be created.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]";
GameServerCluster gameServerCluster = new GameServerCluster();
string gameServerClusterId = "";
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.CreateGameServerClusterAsync(parent, gameServerCluster, gameServerClusterId);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceCreateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

DeleteGameServerCluster(DeleteGameServerClusterRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerCluster(DeleteGameServerClusterRequest request, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
request	DeleteGameServerClusterRequest 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.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
DeleteGameServerClusterRequest request = new DeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = gameServerClustersServiceClient.DeleteGameServerCluster(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceDeleteGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerCluster(GameServerClusterName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerCluster(GameServerClusterName name, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = gameServerClustersServiceClient.DeleteGameServerCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceDeleteGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerCluster(string name, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = gameServerClustersServiceClient.DeleteGameServerCluster(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceDeleteGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(DeleteGameServerClusterRequest request, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
request	DeleteGameServerClusterRequest 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.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerClusterRequest request = new DeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(DeleteGameServerClusterRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(DeleteGameServerClusterRequest request, CancellationToken cancellationToken)

Deletes a single game server cluster.

Parameters
Name	Description
request	DeleteGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerClusterRequest request = new DeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(GameServerClusterName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(GameServerClusterName name, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(GameServerClusterName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(GameServerClusterName name, CancellationToken cancellationToken)

Deletes a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(string name, CallSettings callSettings = null)

Deletes a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteGameServerClusterAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerClusterAsync(string name, CancellationToken cancellationToken)

Deletes a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{location}/gameServerClusters/{cluster}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerClustersServiceClient.DeleteGameServerClusterAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceDeleteGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetGameServerCluster(GameServerClusterName, CallSettings)

public virtual GameServerCluster GetGameServerCluster(GameServerClusterName name, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GameServerCluster	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
GameServerCluster response = gameServerClustersServiceClient.GetGameServerCluster(name);

GetGameServerCluster(GetGameServerClusterRequest, CallSettings)

public virtual GameServerCluster GetGameServerCluster(GetGameServerClusterRequest request, CallSettings callSettings = null)

Gets details of a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
GetGameServerClusterRequest request = new GetGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    View = GameServerClusterView.Unspecified,
};
// Make the request
GameServerCluster response = gameServerClustersServiceClient.GetGameServerCluster(request);

GetGameServerCluster(string, CallSettings)

public virtual GameServerCluster GetGameServerCluster(string name, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GameServerCluster	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
GameServerCluster response = gameServerClustersServiceClient.GetGameServerCluster(name);

GetGameServerClusterAsync(GameServerClusterName, CallSettings)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(GameServerClusterName name, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskGameServerCluster	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(name);

GetGameServerClusterAsync(GameServerClusterName, CancellationToken)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(GameServerClusterName name, CancellationToken cancellationToken)

Gets details of a single game server cluster.

Parameters
Name	Description
name	GameServerClusterName Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskGameServerCluster	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerClusterName name = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(name);

GetGameServerClusterAsync(GetGameServerClusterRequest, CallSettings)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(GetGameServerClusterRequest request, CallSettings callSettings = null)

Gets details of a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerClusterRequest request = new GetGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    View = GameServerClusterView.Unspecified,
};
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(request);

GetGameServerClusterAsync(GetGameServerClusterRequest, CancellationToken)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(GetGameServerClusterRequest request, CancellationToken cancellationToken)

Gets details of a single game server cluster.

Parameters
Name	Description
request	GetGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskGameServerCluster	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerClusterRequest request = new GetGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    View = GameServerClusterView.Unspecified,
};
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(request);

GetGameServerClusterAsync(string, CallSettings)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(string name, CallSettings callSettings = null)

Gets details of a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskGameServerCluster	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(name);

GetGameServerClusterAsync(string, CancellationToken)

public virtual Task<GameServerCluster> GetGameServerClusterAsync(string name, CancellationToken cancellationToken)

Gets details of a single game server cluster.

Parameters
Name	Description
name	string Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskGameServerCluster	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]/gameServerClusters/[CLUSTER]";
// Make the request
GameServerCluster response = await gameServerClustersServiceClient.GetGameServerClusterAsync(name);

ListGameServerClusters(ListGameServerClustersRequest, CallSettings)

public virtual PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClusters(ListGameServerClustersRequest request, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
request	ListGameServerClustersRequest 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
PagedEnumerableListGameServerClustersResponseGameServerCluster	A pageable sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
ListGameServerClustersRequest request = new ListGameServerClustersRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    Filter = "",
    OrderBy = "",
    View = GameServerClusterView.Unspecified,
};
// Make the request
PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClusters(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListGameServerClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListGameServerClusters(RealmName, string, int?, CallSettings)

public virtual PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClusters(RealmName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
parent	RealmName Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListGameServerClustersResponseGameServerCluster	A pageable sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
RealmName parent = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]");
// Make the request
PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListGameServerClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListGameServerClusters(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClusters(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
parent	string Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListGameServerClustersResponseGameServerCluster	A pageable sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]";
// Make the request
PagedEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClusters(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerCluster item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListGameServerClustersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListGameServerClustersAsync(ListGameServerClustersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClustersAsync(ListGameServerClustersRequest request, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
request	ListGameServerClustersRequest 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
PagedAsyncEnumerableListGameServerClustersResponseGameServerCluster	A pageable asynchronous sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
ListGameServerClustersRequest request = new ListGameServerClustersRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    Filter = "",
    OrderBy = "",
    View = GameServerClusterView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClustersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListGameServerClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListGameServerClustersAsync(RealmName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClustersAsync(RealmName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
parent	RealmName Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListGameServerClustersResponseGameServerCluster	A pageable asynchronous sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
RealmName parent = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]");
// Make the request
PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListGameServerClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListGameServerClustersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> ListGameServerClustersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server clusters in a given project and location.

Parameters
Name	Description
parent	string Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}".
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListGameServerClustersResponseGameServerCluster	A pageable asynchronous sequence of GameServerCluster resources.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/realms/[REALM]";
// Make the request
PagedAsyncEnumerable<ListGameServerClustersResponse, GameServerCluster> response = gameServerClustersServiceClient.ListGameServerClustersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerCluster item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListGameServerClustersResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerCluster item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<GameServerCluster> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (GameServerCluster item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateGameServerCluster(string, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> PollOnceCreateGameServerCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationGameServerClusterOperationMetadata	The result of polling the operation.

PollOnceCreateGameServerClusterAsync(string, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> PollOnceCreateGameServerClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A task representing the result of polling the operation.

PollOnceDeleteGameServerCluster(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteGameServerCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The result of polling the operation.

PollOnceDeleteGameServerClusterAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteGameServerClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A task representing the result of polling the operation.

PollOnceUpdateGameServerCluster(string, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> PollOnceUpdateGameServerCluster(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationGameServerClusterOperationMetadata	The result of polling the operation.

PollOnceUpdateGameServerClusterAsync(string, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> PollOnceUpdateGameServerClusterAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateGameServerCluster.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A task representing the result of polling the operation.

PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest, CallSettings)

public virtual PreviewCreateGameServerClusterResponse PreviewCreateGameServerCluster(PreviewCreateGameServerClusterRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
PreviewCreateGameServerClusterRequest request = new PreviewCreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewCreateGameServerClusterResponse response = gameServerClustersServiceClient.PreviewCreateGameServerCluster(request);

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CallSettings)

public virtual Task<PreviewCreateGameServerClusterResponse> PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest request, CallSettings callSettings = null)

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

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewCreateGameServerClusterRequest request = new PreviewCreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewCreateGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewCreateGameServerClusterAsync(request);

PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest, CancellationToken)

public virtual Task<PreviewCreateGameServerClusterResponse> PreviewCreateGameServerClusterAsync(PreviewCreateGameServerClusterRequest request, CancellationToken cancellationToken)

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

Parameters
Name	Description
request	PreviewCreateGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPreviewCreateGameServerClusterResponse	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewCreateGameServerClusterRequest request = new PreviewCreateGameServerClusterRequest
{
    ParentAsRealmName = RealmName.FromProjectLocationRealm("[PROJECT]", "[LOCATION]", "[REALM]"),
    GameServerClusterId = "",
    GameServerCluster = new GameServerCluster(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewCreateGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewCreateGameServerClusterAsync(request);

PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest, CallSettings)

public virtual PreviewDeleteGameServerClusterResponse PreviewDeleteGameServerCluster(PreviewDeleteGameServerClusterRequest request, CallSettings callSettings = null)

Previews deletion of a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
PreviewDeleteGameServerClusterRequest request = new PreviewDeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewDeleteGameServerClusterResponse response = gameServerClustersServiceClient.PreviewDeleteGameServerCluster(request);

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CallSettings)

public virtual Task<PreviewDeleteGameServerClusterResponse> PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest request, CallSettings callSettings = null)

Previews deletion of a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewDeleteGameServerClusterRequest request = new PreviewDeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewDeleteGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewDeleteGameServerClusterAsync(request);

PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest, CancellationToken)

public virtual Task<PreviewDeleteGameServerClusterResponse> PreviewDeleteGameServerClusterAsync(PreviewDeleteGameServerClusterRequest request, CancellationToken cancellationToken)

Previews deletion of a single game server cluster.

Parameters
Name	Description
request	PreviewDeleteGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPreviewDeleteGameServerClusterResponse	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewDeleteGameServerClusterRequest request = new PreviewDeleteGameServerClusterRequest
{
    GameServerClusterName = GameServerClusterName.FromProjectLocationRealmCluster("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]"),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewDeleteGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewDeleteGameServerClusterAsync(request);

PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest, CallSettings)

public virtual PreviewUpdateGameServerClusterResponse PreviewUpdateGameServerCluster(PreviewUpdateGameServerClusterRequest request, CallSettings callSettings = null)

Previews updating a GameServerCluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
PreviewUpdateGameServerClusterRequest request = new PreviewUpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewUpdateGameServerClusterResponse response = gameServerClustersServiceClient.PreviewUpdateGameServerCluster(request);

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CallSettings)

public virtual Task<PreviewUpdateGameServerClusterResponse> PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest request, CallSettings callSettings = null)

Previews updating a GameServerCluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewUpdateGameServerClusterRequest request = new PreviewUpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewUpdateGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewUpdateGameServerClusterAsync(request);

PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest, CancellationToken)

public virtual Task<PreviewUpdateGameServerClusterResponse> PreviewUpdateGameServerClusterAsync(PreviewUpdateGameServerClusterRequest request, CancellationToken cancellationToken)

Previews updating a GameServerCluster.

Parameters
Name	Description
request	PreviewUpdateGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPreviewUpdateGameServerClusterResponse	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewUpdateGameServerClusterRequest request = new PreviewUpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewUpdateGameServerClusterResponse response = await gameServerClustersServiceClient.PreviewUpdateGameServerClusterAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateGameServerCluster(GameServerCluster, FieldMask, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> UpdateGameServerCluster(GameServerCluster gameServerCluster, FieldMask updateMask, CallSettings callSettings = null)

Patches a single game server cluster.

Parameters
Name	Description
gameServerCluster	GameServerCluster Required. The game server cluster to be updated. Only fields specified in update_mask are updated.
updateMask	FieldMask Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationGameServerClusterOperationMetadata	The RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
GameServerCluster gameServerCluster = new GameServerCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerCluster, OperationMetadata> response = gameServerClustersServiceClient.UpdateGameServerCluster(gameServerCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceUpdateGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

UpdateGameServerCluster(UpdateGameServerClusterRequest, CallSettings)

public virtual Operation<GameServerCluster, OperationMetadata> UpdateGameServerCluster(UpdateGameServerClusterRequest request, CallSettings callSettings = null)

Patches a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = GameServerClustersServiceClient.Create();
// Initialize request argument(s)
UpdateGameServerClusterRequest request = new UpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = gameServerClustersServiceClient.UpdateGameServerCluster(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = gameServerClustersServiceClient.PollOnceUpdateGameServerCluster(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

UpdateGameServerClusterAsync(GameServerCluster, FieldMask, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> UpdateGameServerClusterAsync(GameServerCluster gameServerCluster, FieldMask updateMask, CallSettings callSettings = null)

Patches a single game server cluster.

Parameters
Name	Description
gameServerCluster	GameServerCluster Required. The game server cluster to be updated. Only fields specified in update_mask are updated.
updateMask	FieldMask Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerCluster gameServerCluster = new GameServerCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.UpdateGameServerClusterAsync(gameServerCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceUpdateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

UpdateGameServerClusterAsync(GameServerCluster, FieldMask, CancellationToken)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> UpdateGameServerClusterAsync(GameServerCluster gameServerCluster, FieldMask updateMask, CancellationToken cancellationToken)

Patches a single game server cluster.

Parameters
Name	Description
gameServerCluster	GameServerCluster Required. The game server cluster to be updated. Only fields specified in update_mask are updated.
updateMask	FieldMask Required. Mask of fields to update. At least one path must be supplied in this field. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerCluster gameServerCluster = new GameServerCluster();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.UpdateGameServerClusterAsync(gameServerCluster, updateMask);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceUpdateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CallSettings)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> UpdateGameServerClusterAsync(UpdateGameServerClusterRequest request, CallSettings callSettings = null)

Patches a single game server cluster.

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

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerClusterRequest request = new UpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.UpdateGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceUpdateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}

UpdateGameServerClusterAsync(UpdateGameServerClusterRequest, CancellationToken)

public virtual Task<Operation<GameServerCluster, OperationMetadata>> UpdateGameServerClusterAsync(UpdateGameServerClusterRequest request, CancellationToken cancellationToken)

Patches a single game server cluster.

Parameters
Name	Description
request	UpdateGameServerClusterRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationGameServerClusterOperationMetadata	A Task containing the RPC response.

Example

// Create client
GameServerClustersServiceClient gameServerClustersServiceClient = await GameServerClustersServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerClusterRequest request = new UpdateGameServerClusterRequest
{
    GameServerCluster = new GameServerCluster(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerCluster, OperationMetadata> response = await gameServerClustersServiceClient.UpdateGameServerClusterAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerCluster, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerCluster result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<GameServerCluster, OperationMetadata> retrievedResponse = await gameServerClustersServiceClient.PollOnceUpdateGameServerClusterAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerCluster retrievedResult = retrievedResponse.Result;
}