Class GameServerConfigsServiceClient (2.0.0-beta01)

Stay organized with collections Save and categorize content based on your preferences.
public abstract class GameServerConfigsServiceClient

GameServerConfigsService client wrapper, for convenient use.

Inheritance

Object > GameServerConfigsServiceClient

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.dll

Remarks

The game server config configures the game servers in an Agones fleet.

Properties

CreateGameServerConfigOperationsClient

public virtual OperationsClient CreateGameServerConfigOperationsClient { get; }

The long-running operations client for CreateGameServerConfig.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default GameServerConfigsService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default GameServerConfigsService scopes are:

DeleteGameServerConfigOperationsClient

public virtual OperationsClient DeleteGameServerConfigOperationsClient { get; }

The long-running operations client for DeleteGameServerConfig.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual GameServerConfigsService.GameServerConfigsServiceClient GrpcClient { get; }

The underlying gRPC GameServerConfigsService client

Property Value
TypeDescription
GameServerConfigsService.GameServerConfigsServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

Create()

public static GameServerConfigsServiceClient Create()

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

Returns
TypeDescription
GameServerConfigsServiceClient

The created GameServerConfigsServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<GameServerConfigsServiceClient>

The task representing the created GameServerConfigsServiceClient.

CreateGameServerConfig(CreateGameServerConfigRequest, CallSettings)

public virtual Operation<GameServerConfig, OperationMetadata> CreateGameServerConfig(CreateGameServerConfigRequest request, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
requestCreateGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerConfig, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
CreateGameServerConfigRequest request = new CreateGameServerConfigRequest
{
    ParentAsGameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    ConfigId = "",
    GameServerConfig = new GameServerConfig(),
};
// Make the request
Operation<GameServerConfig, OperationMetadata> response = gameServerConfigsServiceClient.CreateGameServerConfig(request);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = gameServerConfigsServiceClient.PollOnceCreateGameServerConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfig(GameServerDeploymentName, GameServerConfig, CallSettings)

public virtual Operation<GameServerConfig, OperationMetadata> CreateGameServerConfig(GameServerDeploymentName parent, GameServerConfig gameServerConfig, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentGameServerDeploymentName

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerConfig, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentName parent = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = gameServerConfigsServiceClient.CreateGameServerConfig(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = gameServerConfigsServiceClient.PollOnceCreateGameServerConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfig(String, GameServerConfig, CallSettings)

public virtual Operation<GameServerConfig, OperationMetadata> CreateGameServerConfig(string parent, GameServerConfig gameServerConfig, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerConfig, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = gameServerConfigsServiceClient.CreateGameServerConfig(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = gameServerConfigsServiceClient.PollOnceCreateGameServerConfig(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(CreateGameServerConfigRequest, CallSettings)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(CreateGameServerConfigRequest request, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
requestCreateGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerConfigRequest request = new CreateGameServerConfigRequest
{
    ParentAsGameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    ConfigId = "",
    GameServerConfig = new GameServerConfig(),
};
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(CreateGameServerConfigRequest, CancellationToken)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(CreateGameServerConfigRequest request, CancellationToken cancellationToken)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
requestCreateGameServerConfigRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerConfigRequest request = new CreateGameServerConfigRequest
{
    ParentAsGameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    ConfigId = "",
    GameServerConfig = new GameServerConfig(),
};
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(request);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(GameServerDeploymentName, GameServerConfig, CallSettings)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(GameServerDeploymentName parent, GameServerConfig gameServerConfig, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentGameServerDeploymentName

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName parent = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(GameServerDeploymentName, GameServerConfig, CancellationToken)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(GameServerDeploymentName parent, GameServerConfig gameServerConfig, CancellationToken cancellationToken)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentGameServerDeploymentName

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName parent = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(String, GameServerConfig, CallSettings)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(string parent, GameServerConfig gameServerConfig, CallSettings callSettings = null)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

CreateGameServerConfigAsync(String, GameServerConfig, CancellationToken)

public virtual Task<Operation<GameServerConfig, OperationMetadata>> CreateGameServerConfigAsync(string parent, GameServerConfig gameServerConfig, CancellationToken cancellationToken)

Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/.

gameServerConfigGameServerConfig

Required. The game server config resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
GameServerConfig gameServerConfig = new GameServerConfig();
// Make the request
Operation<GameServerConfig, OperationMetadata> response = await gameServerConfigsServiceClient.CreateGameServerConfigAsync(parent, gameServerConfig);

// Poll until the returned long-running operation is complete
Operation<GameServerConfig, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
GameServerConfig 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<GameServerConfig, OperationMetadata> retrievedResponse = await gameServerConfigsServiceClient.PollOnceCreateGameServerConfigAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    GameServerConfig retrievedResult = retrievedResponse.Result;
}

DeleteGameServerConfig(DeleteGameServerConfigRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerConfig(DeleteGameServerConfigRequest request, CallSettings callSettings = null)

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
requestDeleteGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
DeleteGameServerConfigRequest request = new DeleteGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = gameServerConfigsServiceClient.DeleteGameServerConfig(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 = gameServerConfigsServiceClient.PollOnceDeleteGameServerConfig(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;
}

DeleteGameServerConfig(GameServerConfigName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerConfig(GameServerConfigName name, CallSettings callSettings = null)

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = gameServerConfigsServiceClient.DeleteGameServerConfig(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 = gameServerConfigsServiceClient.PollOnceDeleteGameServerConfig(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;
}

DeleteGameServerConfig(String, CallSettings)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameString

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = gameServerConfigsServiceClient.DeleteGameServerConfig(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 = gameServerConfigsServiceClient.PollOnceDeleteGameServerConfig(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;
}

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CallSettings)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
requestDeleteGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerConfigRequest request = new DeleteGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

DeleteGameServerConfigAsync(DeleteGameServerConfigRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerConfigAsync(DeleteGameServerConfigRequest request, CancellationToken cancellationToken)

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
requestDeleteGameServerConfigRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerConfigRequest request = new DeleteGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

DeleteGameServerConfigAsync(GameServerConfigName, CallSettings)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

DeleteGameServerConfigAsync(GameServerConfigName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerConfigAsync(GameServerConfigName name, CancellationToken cancellationToken)

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

DeleteGameServerConfigAsync(String, CallSettings)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameString

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

DeleteGameServerConfigAsync(String, CancellationToken)

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

Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.

Parameters
NameDescription
nameString

Required. The name of the game server config to delete. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerConfigsServiceClient.DeleteGameServerConfigAsync(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 gameServerConfigsServiceClient.PollOnceDeleteGameServerConfigAsync(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;
}

GetGameServerConfig(GameServerConfigName, CallSettings)

public virtual GameServerConfig GetGameServerConfig(GameServerConfigName name, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerConfig

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
GameServerConfig response = gameServerConfigsServiceClient.GetGameServerConfig(name);

GetGameServerConfig(GetGameServerConfigRequest, CallSettings)

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

Gets details of a single game server config.

Parameters
NameDescription
requestGetGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerConfig

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
GetGameServerConfigRequest request = new GetGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
GameServerConfig response = gameServerConfigsServiceClient.GetGameServerConfig(request);

GetGameServerConfig(String, CallSettings)

public virtual GameServerConfig GetGameServerConfig(string name, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
nameString

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerConfig

The RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
GameServerConfig response = gameServerConfigsServiceClient.GetGameServerConfig(name);

GetGameServerConfigAsync(GameServerConfigName, CallSettings)

public virtual Task<GameServerConfig> GetGameServerConfigAsync(GameServerConfigName name, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(name);

GetGameServerConfigAsync(GameServerConfigName, CancellationToken)

public virtual Task<GameServerConfig> GetGameServerConfigAsync(GameServerConfigName name, CancellationToken cancellationToken)

Gets details of a single game server config.

Parameters
NameDescription
nameGameServerConfigName

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerConfigName name = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(name);

GetGameServerConfigAsync(GetGameServerConfigRequest, CallSettings)

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

Gets details of a single game server config.

Parameters
NameDescription
requestGetGameServerConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerConfigRequest request = new GetGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(request);

GetGameServerConfigAsync(GetGameServerConfigRequest, CancellationToken)

public virtual Task<GameServerConfig> GetGameServerConfigAsync(GetGameServerConfigRequest request, CancellationToken cancellationToken)

Gets details of a single game server config.

Parameters
NameDescription
requestGetGameServerConfigRequest

The request object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerConfigRequest request = new GetGameServerConfigRequest
{
    GameServerConfigName = GameServerConfigName.FromProjectLocationDeploymentConfig("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]"),
};
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(request);

GetGameServerConfigAsync(String, CallSettings)

public virtual Task<GameServerConfig> GetGameServerConfigAsync(string name, CallSettings callSettings = null)

Gets details of a single game server config.

Parameters
NameDescription
nameString

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(name);

GetGameServerConfigAsync(String, CancellationToken)

public virtual Task<GameServerConfig> GetGameServerConfigAsync(string name, CancellationToken cancellationToken)

Gets details of a single game server config.

Parameters
NameDescription
nameString

Required. The name of the game server config to retrieve. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerConfig>

A Task containing the RPC response.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]/configs/[CONFIG]";
// Make the request
GameServerConfig response = await gameServerConfigsServiceClient.GetGameServerConfigAsync(name);

ListGameServerConfigs(GameServerDeploymentName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigs(GameServerDeploymentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentGameServerDeploymentName

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentName parent = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerConfig 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 (ListGameServerConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

ListGameServerConfigs(ListGameServerConfigsRequest, CallSettings)

public virtual PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigs(ListGameServerConfigsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListGameServerConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
ListGameServerConfigsRequest request = new ListGameServerConfigsRequest
{
    ParentAsGameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerConfig 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 (ListGameServerConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

ListGameServerConfigs(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigs(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = GameServerConfigsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
PagedEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (GameServerConfig 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 (ListGameServerConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

ListGameServerConfigsAsync(GameServerDeploymentName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigsAsync(GameServerDeploymentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentGameServerDeploymentName

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable asynchronous sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName parent = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerConfig 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((ListGameServerConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

ListGameServerConfigsAsync(ListGameServerConfigsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigsAsync(ListGameServerConfigsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListGameServerConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable asynchronous sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
ListGameServerConfigsRequest request = new ListGameServerConfigsRequest
{
    ParentAsGameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerConfig 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((ListGameServerConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

ListGameServerConfigsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> ListGameServerConfigsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form:

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig>

A pageable asynchronous sequence of GameServerConfig resources.

Example
// Create client
GameServerConfigsServiceClient gameServerConfigsServiceClient = await GameServerConfigsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
PagedAsyncEnumerable<ListGameServerConfigsResponse, GameServerConfig> response = gameServerConfigsServiceClient.ListGameServerConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((GameServerConfig 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((ListGameServerConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (GameServerConfig 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<GameServerConfig> 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 (GameServerConfig 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;

PollOnceCreateGameServerConfig(String, CallSettings)

public virtual Operation<GameServerConfig, OperationMetadata> PollOnceCreateGameServerConfig(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerConfig, OperationMetadata>

The result of polling the operation.

PollOnceCreateGameServerConfigAsync(String, CallSettings)

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

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

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerConfig, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceDeleteGameServerConfig(String, CallSettings)

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

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

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The result of polling the operation.

PollOnceDeleteGameServerConfigAsync(String, CallSettings)

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

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

Parameters
NameDescription
operationNameString

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A task representing the result of polling the operation.

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