Class GameServerDeploymentsServiceClient (2.0.0-beta01)

public abstract class GameServerDeploymentsServiceClient

GameServerDeploymentsService client wrapper, for convenient use.

Inheritance

Object > GameServerDeploymentsServiceClient

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.dll

Remarks

The game server deployment is used to control the deployment of Agones fleets.

Properties

CreateGameServerDeploymentOperationsClient

public virtual OperationsClient CreateGameServerDeploymentOperationsClient { get; }

The long-running operations client for CreateGameServerDeployment.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the GameServerDeploymentsService 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 GameServerDeploymentsService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default GameServerDeploymentsService scopes are:

DeleteGameServerDeploymentOperationsClient

public virtual OperationsClient DeleteGameServerDeploymentOperationsClient { get; }

The long-running operations client for DeleteGameServerDeployment.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual GameServerDeploymentsService.GameServerDeploymentsServiceClient GrpcClient { get; }

The underlying gRPC GameServerDeploymentsService client

Property Value
TypeDescription
GameServerDeploymentsService.GameServerDeploymentsServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

UpdateGameServerDeploymentOperationsClient

public virtual OperationsClient UpdateGameServerDeploymentOperationsClient { get; }

The long-running operations client for UpdateGameServerDeployment.

Property Value
TypeDescription
OperationsClient

UpdateGameServerDeploymentRolloutOperationsClient

public virtual OperationsClient UpdateGameServerDeploymentRolloutOperationsClient { get; }

The long-running operations client for UpdateGameServerDeploymentRollout.

Property Value
TypeDescription
OperationsClient

Methods

Create()

public static GameServerDeploymentsServiceClient Create()

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

Returns
TypeDescription
GameServerDeploymentsServiceClient

The created GameServerDeploymentsServiceClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<GameServerDeploymentsServiceClient>

The task representing the created GameServerDeploymentsServiceClient.

CreateGameServerDeployment(LocationName, GameServerDeployment, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> CreateGameServerDeployment(LocationName parent, GameServerDeployment gameServerDeployment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.CreateGameServerDeployment(parent, gameServerDeployment);

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

CreateGameServerDeployment(CreateGameServerDeploymentRequest, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> CreateGameServerDeployment(CreateGameServerDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateGameServerDeploymentRequest

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<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
CreateGameServerDeploymentRequest request = new CreateGameServerDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    GameServerDeployment = new GameServerDeployment(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.CreateGameServerDeployment(request);

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

CreateGameServerDeployment(String, GameServerDeployment, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> CreateGameServerDeployment(string parent, GameServerDeployment gameServerDeployment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.CreateGameServerDeployment(parent, gameServerDeployment);

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

CreateGameServerDeploymentAsync(LocationName, GameServerDeployment, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(LocationName parent, GameServerDeployment gameServerDeployment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(parent, gameServerDeployment);

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

CreateGameServerDeploymentAsync(LocationName, GameServerDeployment, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(LocationName parent, GameServerDeployment gameServerDeployment, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentLocationName

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(parent, gameServerDeployment);

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

CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateGameServerDeploymentRequest

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<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerDeploymentRequest request = new CreateGameServerDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    GameServerDeployment = new GameServerDeployment(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(request);

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

CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(CreateGameServerDeploymentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestCreateGameServerDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
CreateGameServerDeploymentRequest request = new CreateGameServerDeploymentRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    DeploymentId = "",
    GameServerDeployment = new GameServerDeployment(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(request);

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

CreateGameServerDeploymentAsync(String, GameServerDeployment, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(string parent, GameServerDeployment gameServerDeployment, CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(parent, gameServerDeployment);

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

CreateGameServerDeploymentAsync(String, GameServerDeployment, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> CreateGameServerDeploymentAsync(string parent, GameServerDeployment gameServerDeployment, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

gameServerDeploymentGameServerDeployment

Required. The game server delpoyment resource to be created.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
GameServerDeployment gameServerDeployment = new GameServerDeployment();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.CreateGameServerDeploymentAsync(parent, gameServerDeployment);

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

DeleteGameServerDeployment(DeleteGameServerDeploymentRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerDeployment(DeleteGameServerDeploymentRequest request, CallSettings callSettings = null)

Deletes a single game server deployment.

Parameters
NameDescription
requestDeleteGameServerDeploymentRequest

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
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
DeleteGameServerDeploymentRequest request = new DeleteGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = gameServerDeploymentsServiceClient.DeleteGameServerDeployment(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 = gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeployment(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;
}

DeleteGameServerDeployment(GameServerDeploymentName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteGameServerDeployment(GameServerDeploymentName name, CallSettings callSettings = null)

Deletes a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = gameServerDeploymentsServiceClient.DeleteGameServerDeployment(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 = gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeployment(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;
}

DeleteGameServerDeployment(String, CallSettings)

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

Deletes a single game server deployment.

Parameters
NameDescription
nameString

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, OperationMetadata>

The RPC response.

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

DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CallSettings)

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

Deletes a single game server deployment.

Parameters
NameDescription
requestDeleteGameServerDeploymentRequest

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
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerDeploymentRequest request = new DeleteGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(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 gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(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;
}

DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerDeploymentAsync(DeleteGameServerDeploymentRequest request, CancellationToken cancellationToken)

Deletes a single game server deployment.

Parameters
NameDescription
requestDeleteGameServerDeploymentRequest

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
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteGameServerDeploymentRequest request = new DeleteGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(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 gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(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;
}

DeleteGameServerDeploymentAsync(GameServerDeploymentName, CallSettings)

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

Deletes a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

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
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(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 gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(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;
}

DeleteGameServerDeploymentAsync(GameServerDeploymentName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteGameServerDeploymentAsync(GameServerDeploymentName name, CancellationToken cancellationToken)

Deletes a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(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 gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(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;
}

DeleteGameServerDeploymentAsync(String, CallSettings)

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

Deletes a single game server deployment.

Parameters
NameDescription
nameString

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

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

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
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
Operation<Empty, OperationMetadata> response = await gameServerDeploymentsServiceClient.DeleteGameServerDeploymentAsync(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 gameServerDeploymentsServiceClient.PollOnceDeleteGameServerDeploymentAsync(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;
}

DeleteGameServerDeploymentAsync(String, CancellationToken)

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

Deletes a single game server deployment.

Parameters
NameDescription
nameString

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<Empty, OperationMetadata>>

A Task containing the RPC response.

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

FetchDeploymentState(FetchDeploymentStateRequest, CallSettings)

public virtual FetchDeploymentStateResponse FetchDeploymentState(FetchDeploymentStateRequest request, CallSettings callSettings = null)

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters
NameDescription
requestFetchDeploymentStateRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FetchDeploymentStateResponse

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
FetchDeploymentStateRequest request = new FetchDeploymentStateRequest { Name = "", };
// Make the request
FetchDeploymentStateResponse response = gameServerDeploymentsServiceClient.FetchDeploymentState(request);

FetchDeploymentStateAsync(FetchDeploymentStateRequest, CallSettings)

public virtual Task<FetchDeploymentStateResponse> FetchDeploymentStateAsync(FetchDeploymentStateRequest request, CallSettings callSettings = null)

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters
NameDescription
requestFetchDeploymentStateRequest

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

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
FetchDeploymentStateRequest request = new FetchDeploymentStateRequest { Name = "", };
// Make the request
FetchDeploymentStateResponse response = await gameServerDeploymentsServiceClient.FetchDeploymentStateAsync(request);

FetchDeploymentStateAsync(FetchDeploymentStateRequest, CancellationToken)

public virtual Task<FetchDeploymentStateResponse> FetchDeploymentStateAsync(FetchDeploymentStateRequest request, CancellationToken cancellationToken)

Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.

Parameters
NameDescription
requestFetchDeploymentStateRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<FetchDeploymentStateResponse>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
FetchDeploymentStateRequest request = new FetchDeploymentStateRequest { Name = "", };
// Make the request
FetchDeploymentStateResponse response = await gameServerDeploymentsServiceClient.FetchDeploymentStateAsync(request);

GetGameServerDeployment(GameServerDeploymentName, CallSettings)

public virtual GameServerDeployment GetGameServerDeployment(GameServerDeploymentName name, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeployment

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeployment response = gameServerDeploymentsServiceClient.GetGameServerDeployment(name);

GetGameServerDeployment(GetGameServerDeploymentRequest, CallSettings)

public virtual GameServerDeployment GetGameServerDeployment(GetGameServerDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
requestGetGameServerDeploymentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeployment

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GetGameServerDeploymentRequest request = new GetGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeployment response = gameServerDeploymentsServiceClient.GetGameServerDeployment(request);

GetGameServerDeployment(String, CallSettings)

public virtual GameServerDeployment GetGameServerDeployment(string name, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
nameString

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeployment

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeployment response = gameServerDeploymentsServiceClient.GetGameServerDeployment(name);

GetGameServerDeploymentAsync(GameServerDeploymentName, CallSettings)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(GameServerDeploymentName name, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeployment>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(name);

GetGameServerDeploymentAsync(GameServerDeploymentName, CancellationToken)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(GameServerDeploymentName name, CancellationToken cancellationToken)

Gets details of a single game server deployment.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeployment>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(name);

GetGameServerDeploymentAsync(GetGameServerDeploymentRequest, CallSettings)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(GetGameServerDeploymentRequest request, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
requestGetGameServerDeploymentRequest

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

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerDeploymentRequest request = new GetGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(request);

GetGameServerDeploymentAsync(GetGameServerDeploymentRequest, CancellationToken)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(GetGameServerDeploymentRequest request, CancellationToken cancellationToken)

Gets details of a single game server deployment.

Parameters
NameDescription
requestGetGameServerDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeployment>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerDeploymentRequest request = new GetGameServerDeploymentRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(request);

GetGameServerDeploymentAsync(String, CallSettings)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(string name, CallSettings callSettings = null)

Gets details of a single game server deployment.

Parameters
NameDescription
nameString

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeployment>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(name);

GetGameServerDeploymentAsync(String, CancellationToken)

public virtual Task<GameServerDeployment> GetGameServerDeploymentAsync(string name, CancellationToken cancellationToken)

Gets details of a single game server deployment.

Parameters
NameDescription
nameString

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeployment>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeployment response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentAsync(name);

GetGameServerDeploymentRollout(GameServerDeploymentName, CallSettings)

public virtual GameServerDeploymentRollout GetGameServerDeploymentRollout(GameServerDeploymentName name, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeploymentRollout

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeploymentRollout response = gameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(name);

GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest, CallSettings)

public virtual GameServerDeploymentRollout GetGameServerDeploymentRollout(GetGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
requestGetGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeploymentRollout

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GetGameServerDeploymentRolloutRequest request = new GetGameServerDeploymentRolloutRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeploymentRollout response = gameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(request);

GetGameServerDeploymentRollout(String, CallSettings)

public virtual GameServerDeploymentRollout GetGameServerDeploymentRollout(string name, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameString

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
GameServerDeploymentRollout

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeploymentRollout response = gameServerDeploymentsServiceClient.GetGameServerDeploymentRollout(name);

GetGameServerDeploymentRolloutAsync(GameServerDeploymentName, CallSettings)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(GameServerDeploymentName name, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(name);

GetGameServerDeploymentRolloutAsync(GameServerDeploymentName, CancellationToken)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(GameServerDeploymentName name, CancellationToken cancellationToken)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameGameServerDeploymentName

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentName name = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(name);

GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest, CallSettings)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
requestGetGameServerDeploymentRolloutRequest

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

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerDeploymentRolloutRequest request = new GetGameServerDeploymentRolloutRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(request);

GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest, CancellationToken)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(GetGameServerDeploymentRolloutRequest request, CancellationToken cancellationToken)

Gets details a single game server deployment rollout.

Parameters
NameDescription
requestGetGameServerDeploymentRolloutRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GetGameServerDeploymentRolloutRequest request = new GetGameServerDeploymentRolloutRequest
{
    GameServerDeploymentName = GameServerDeploymentName.FromProjectLocationDeployment("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]"),
};
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(request);

GetGameServerDeploymentRolloutAsync(String, CallSettings)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(string name, CallSettings callSettings = null)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameString

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(name);

GetGameServerDeploymentRolloutAsync(String, CancellationToken)

public virtual Task<GameServerDeploymentRollout> GetGameServerDeploymentRolloutAsync(string name, CancellationToken cancellationToken)

Gets details a single game server deployment rollout.

Parameters
NameDescription
nameString

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

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<GameServerDeploymentRollout>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/gameServerDeployments/[DEPLOYMENT]";
// Make the request
GameServerDeploymentRollout response = await gameServerDeploymentsServiceClient.GetGameServerDeploymentRolloutAsync(name);

ListGameServerDeployments(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeployments(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeployments(parent);

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

ListGameServerDeployments(ListGameServerDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeployments(ListGameServerDeploymentsRequest request, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
requestListGameServerDeploymentsRequest

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
ListGameServerDeploymentsRequest request = new ListGameServerDeploymentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeployments(request);

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

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

public virtual PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeployments(parent);

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

ListGameServerDeploymentsAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeploymentsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
parentLocationName

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable asynchronous sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(parent);

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

ListGameServerDeploymentsAsync(ListGameServerDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeploymentsAsync(ListGameServerDeploymentsRequest request, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
requestListGameServerDeploymentsRequest

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable asynchronous sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
ListGameServerDeploymentsRequest request = new ListGameServerDeploymentsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(request);

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

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

public virtual PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> ListGameServerDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists game server deployments in a given project and location.

Parameters
NameDescription
parentString

Required. The parent resource name. Uses the form: projects/{project}/locations/{location}.

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<ListGameServerDeploymentsResponse, GameServerDeployment>

A pageable asynchronous sequence of GameServerDeployment resources.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListGameServerDeploymentsResponse, GameServerDeployment> response = gameServerDeploymentsServiceClient.ListGameServerDeploymentsAsync(parent);

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

PollOnceCreateGameServerDeployment(String, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> PollOnceCreateGameServerDeployment(string operationName, CallSettings callSettings = null)

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

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<GameServerDeployment, OperationMetadata>

The result of polling the operation.

PollOnceCreateGameServerDeploymentAsync(String, CallSettings)

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

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

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<GameServerDeployment, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceDeleteGameServerDeployment(String, CallSettings)

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

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

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.

PollOnceDeleteGameServerDeploymentAsync(String, CallSettings)

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

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

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.

PollOnceUpdateGameServerDeployment(String, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> PollOnceUpdateGameServerDeployment(string operationName, CallSettings callSettings = null)

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

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<GameServerDeployment, OperationMetadata>

The result of polling the operation.

PollOnceUpdateGameServerDeploymentAsync(String, CallSettings)

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

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

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<GameServerDeployment, OperationMetadata>>

A task representing the result of polling the operation.

PollOnceUpdateGameServerDeploymentRollout(String, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> PollOnceUpdateGameServerDeploymentRollout(string operationName, CallSettings callSettings = null)

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

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<GameServerDeployment, OperationMetadata>

The result of polling the operation.

PollOnceUpdateGameServerDeploymentRolloutAsync(String, CallSettings)

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

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

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<GameServerDeployment, OperationMetadata>>

A task representing the result of polling the operation.

PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest, CallSettings)

public virtual PreviewGameServerDeploymentRolloutResponse PreviewGameServerDeploymentRollout(PreviewGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters
NameDescription
requestPreviewGameServerDeploymentRolloutRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PreviewGameServerDeploymentRolloutResponse

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
PreviewGameServerDeploymentRolloutRequest request = new PreviewGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewGameServerDeploymentRolloutResponse response = gameServerDeploymentsServiceClient.PreviewGameServerDeploymentRollout(request);

PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest, CallSettings)

public virtual Task<PreviewGameServerDeploymentRolloutResponse> PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters
NameDescription
requestPreviewGameServerDeploymentRolloutRequest

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

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewGameServerDeploymentRolloutRequest request = new PreviewGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewGameServerDeploymentRolloutResponse response = await gameServerDeploymentsServiceClient.PreviewGameServerDeploymentRolloutAsync(request);

PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest, CancellationToken)

public virtual Task<PreviewGameServerDeploymentRolloutResponse> PreviewGameServerDeploymentRolloutAsync(PreviewGameServerDeploymentRolloutRequest request, CancellationToken cancellationToken)

Previews the game server deployment rollout. This API does not mutate the rollout resource.

Parameters
NameDescription
requestPreviewGameServerDeploymentRolloutRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<PreviewGameServerDeploymentRolloutResponse>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
PreviewGameServerDeploymentRolloutRequest request = new PreviewGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
    PreviewTime = new Timestamp(),
};
// Make the request
PreviewGameServerDeploymentRolloutResponse response = await gameServerDeploymentsServiceClient.PreviewGameServerDeploymentRolloutAsync(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
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.

UpdateGameServerDeployment(GameServerDeployment, FieldMask, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeployment(GameServerDeployment gameServerDeployment, FieldMask updateMask, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
NameDescription
gameServerDeploymentGameServerDeployment

Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GameServerDeployment gameServerDeployment = new GameServerDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.UpdateGameServerDeployment(gameServerDeployment, updateMask);

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

UpdateGameServerDeployment(UpdateGameServerDeploymentRequest, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeployment(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
NameDescription
requestUpdateGameServerDeploymentRequest

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<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
UpdateGameServerDeploymentRequest request = new UpdateGameServerDeploymentRequest
{
    GameServerDeployment = new GameServerDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.UpdateGameServerDeployment(request);

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

UpdateGameServerDeploymentAsync(GameServerDeployment, FieldMask, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment, FieldMask updateMask, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
NameDescription
gameServerDeploymentGameServerDeployment

Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeployment gameServerDeployment = new GameServerDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(gameServerDeployment, updateMask);

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

UpdateGameServerDeploymentAsync(GameServerDeployment, FieldMask, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(GameServerDeployment gameServerDeployment, FieldMask updateMask, CancellationToken cancellationToken)

Patches a game server deployment.

Parameters
NameDescription
gameServerDeploymentGameServerDeployment

Required. The game server delpoyment to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeployment gameServerDeployment = new GameServerDeployment();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(gameServerDeployment, updateMask);

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

UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request, CallSettings callSettings = null)

Patches a game server deployment.

Parameters
NameDescription
requestUpdateGameServerDeploymentRequest

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<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerDeploymentRequest request = new UpdateGameServerDeploymentRequest
{
    GameServerDeployment = new GameServerDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(request);

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

UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentAsync(UpdateGameServerDeploymentRequest request, CancellationToken cancellationToken)

Patches a game server deployment.

Parameters
NameDescription
requestUpdateGameServerDeploymentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerDeploymentRequest request = new UpdateGameServerDeploymentRequest
{
    GameServerDeployment = new GameServerDeployment(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentAsync(request);

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

UpdateGameServerDeploymentRollout(GameServerDeploymentRollout, FieldMask, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeploymentRollout(GameServerDeploymentRollout rollout, FieldMask updateMask, CallSettings callSettings = null)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
rolloutGameServerDeploymentRollout

Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
GameServerDeploymentRollout rollout = new GameServerDeploymentRollout();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRollout(rollout, updateMask);

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

UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest, CallSettings)

public virtual Operation<GameServerDeployment, OperationMetadata> UpdateGameServerDeploymentRollout(UpdateGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
requestUpdateGameServerDeploymentRolloutRequest

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<GameServerDeployment, OperationMetadata>

The RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = GameServerDeploymentsServiceClient.Create();
// Initialize request argument(s)
UpdateGameServerDeploymentRolloutRequest request = new UpdateGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRollout(request);

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

UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout, FieldMask, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout rollout, FieldMask updateMask, CallSettings callSettings = null)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
rolloutGameServerDeploymentRollout

Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentRollout rollout = new GameServerDeploymentRollout();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(rollout, updateMask);

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

UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout, FieldMask, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentRolloutAsync(GameServerDeploymentRollout rollout, FieldMask updateMask, CancellationToken cancellationToken)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
rolloutGameServerDeploymentRollout

Required. The game server delpoyment rollout to be updated. Only fields specified in update_mask are updated.

updateMaskFieldMask

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
GameServerDeploymentRollout rollout = new GameServerDeploymentRollout();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(rollout, updateMask);

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

UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CallSettings)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest request, CallSettings callSettings = null)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
requestUpdateGameServerDeploymentRolloutRequest

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<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerDeploymentRolloutRequest request = new UpdateGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(request);

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

UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest, CancellationToken)

public virtual Task<Operation<GameServerDeployment, OperationMetadata>> UpdateGameServerDeploymentRolloutAsync(UpdateGameServerDeploymentRolloutRequest request, CancellationToken cancellationToken)

Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.

Parameters
NameDescription
requestUpdateGameServerDeploymentRolloutRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<Operation<GameServerDeployment, OperationMetadata>>

A Task containing the RPC response.

Example
// Create client
GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient = await GameServerDeploymentsServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateGameServerDeploymentRolloutRequest request = new UpdateGameServerDeploymentRolloutRequest
{
    Rollout = new GameServerDeploymentRollout(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<GameServerDeployment, OperationMetadata> response = await gameServerDeploymentsServiceClient.UpdateGameServerDeploymentRolloutAsync(request);

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