Backup for GKE v1 API - Class BackupForGKEClient (2.5.0)

public abstract class BackupForGKEClient

Reference documentation and code samples for the Backup for GKE v1 API class BackupForGKEClient.

BackupForGKE client wrapper, for convenient use.

Inheritance

object > BackupForGKEClient

Derived Types

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Remarks

BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.

Properties

CreateBackupOperationsClient

public virtual OperationsClient CreateBackupOperationsClient { get; }

The long-running operations client for CreateBackup.

Property Value
Type Description
OperationsClient

CreateBackupPlanOperationsClient

public virtual OperationsClient CreateBackupPlanOperationsClient { get; }

The long-running operations client for CreateBackupPlan.

Property Value
Type Description
OperationsClient

CreateRestoreOperationsClient

public virtual OperationsClient CreateRestoreOperationsClient { get; }

The long-running operations client for CreateRestore.

Property Value
Type Description
OperationsClient

CreateRestorePlanOperationsClient

public virtual OperationsClient CreateRestorePlanOperationsClient { get; }

The long-running operations client for CreateRestorePlan.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default BackupForGKE scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default BackupForGKE scopes are:

DeleteBackupOperationsClient

public virtual OperationsClient DeleteBackupOperationsClient { get; }

The long-running operations client for DeleteBackup.

Property Value
Type Description
OperationsClient

DeleteBackupPlanOperationsClient

public virtual OperationsClient DeleteBackupPlanOperationsClient { get; }

The long-running operations client for DeleteBackupPlan.

Property Value
Type Description
OperationsClient

DeleteRestoreOperationsClient

public virtual OperationsClient DeleteRestoreOperationsClient { get; }

The long-running operations client for DeleteRestore.

Property Value
Type Description
OperationsClient

DeleteRestorePlanOperationsClient

public virtual OperationsClient DeleteRestorePlanOperationsClient { get; }

The long-running operations client for DeleteRestorePlan.

Property Value
Type Description
OperationsClient

GrpcClient

public virtual BackupForGKE.BackupForGKEClient GrpcClient { get; }

The underlying gRPC BackupForGKE client

Property Value
Type Description
BackupForGKEBackupForGKEClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

UpdateBackupOperationsClient

public virtual OperationsClient UpdateBackupOperationsClient { get; }

The long-running operations client for UpdateBackup.

Property Value
Type Description
OperationsClient

UpdateBackupPlanOperationsClient

public virtual OperationsClient UpdateBackupPlanOperationsClient { get; }

The long-running operations client for UpdateBackupPlan.

Property Value
Type Description
OperationsClient

UpdateRestoreOperationsClient

public virtual OperationsClient UpdateRestoreOperationsClient { get; }

The long-running operations client for UpdateRestore.

Property Value
Type Description
OperationsClient

UpdateRestorePlanOperationsClient

public virtual OperationsClient UpdateRestorePlanOperationsClient { get; }

The long-running operations client for UpdateRestorePlan.

Property Value
Type Description
OperationsClient

Methods

Create()

public static BackupForGKEClient Create()

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

Returns
Type Description
BackupForGKEClient

The created BackupForGKEClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskBackupForGKEClient

The task representing the created BackupForGKEClient.

CreateBackup(BackupPlanName, Backup, string, CallSettings)

public virtual Operation<Backup, OperationMetadata> CreateBackup(BackupPlanName parent, Backup backup, string backupId, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent BackupPlanName

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupPlanName parent = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = backupForGKEClient.CreateBackup(parent, backup, backupId);

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

CreateBackup(CreateBackupRequest, CallSettings)

public virtual Operation<Backup, OperationMetadata> CreateBackup(CreateBackupRequest request, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
request CreateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsBackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Backup = new Backup(),
    BackupId = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = backupForGKEClient.CreateBackup(request);

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

CreateBackup(string, Backup, string, CallSettings)

public virtual Operation<Backup, OperationMetadata> CreateBackup(string parent, Backup backup, string backupId, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent string

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = backupForGKEClient.CreateBackup(parent, backup, backupId);

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

CreateBackupAsync(BackupPlanName, Backup, string, CallSettings)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(BackupPlanName parent, Backup backup, string backupId, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent BackupPlanName

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName parent = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(parent, backup, backupId);

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

CreateBackupAsync(BackupPlanName, Backup, string, CancellationToken)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(BackupPlanName parent, Backup backup, string backupId, CancellationToken cancellationToken)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent BackupPlanName

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName parent = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(parent, backup, backupId);

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

CreateBackupAsync(CreateBackupRequest, CallSettings)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(CreateBackupRequest request, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
request CreateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsBackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Backup = new Backup(),
    BackupId = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(request);

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

CreateBackupAsync(CreateBackupRequest, CancellationToken)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(CreateBackupRequest request, CancellationToken cancellationToken)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
request CreateBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateBackupRequest request = new CreateBackupRequest
{
    ParentAsBackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Backup = new Backup(),
    BackupId = "",
};
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(request);

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

CreateBackupAsync(string, Backup, string, CallSettings)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(string parent, Backup backup, string backupId, CallSettings callSettings = null)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent string

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(parent, backup, backupId);

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

CreateBackupAsync(string, Backup, string, CancellationToken)

public virtual Task<Operation<Backup, OperationMetadata>> CreateBackupAsync(string parent, Backup backup, string backupId, CancellationToken cancellationToken)

Creates a Backup for the given BackupPlan.

Parameters
Name Description
parent string

Required. The BackupPlan within which to create the Backup. Format: projects/*/locations/*/backupPlans/*

backup Backup

Optional. The Backup resource to create.

backupId string

Optional. The client-provided short name for the Backup resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Backups in this BackupPlan
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
Backup backup = new Backup();
string backupId = "";
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.CreateBackupAsync(parent, backup, backupId);

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

CreateBackupPlan(LocationName, BackupPlan, string, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> CreateBackupPlan(LocationName parent, BackupPlan backupPlan, string backupPlanId, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = backupForGKEClient.CreateBackupPlan(parent, backupPlan, backupPlanId);

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

CreateBackupPlan(CreateBackupPlanRequest, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> CreateBackupPlan(CreateBackupPlanRequest request, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
request CreateBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
CreateBackupPlanRequest request = new CreateBackupPlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    BackupPlan = new BackupPlan(),
    BackupPlanId = "",
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = backupForGKEClient.CreateBackupPlan(request);

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

CreateBackupPlan(string, BackupPlan, string, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> CreateBackupPlan(string parent, BackupPlan backupPlan, string backupPlanId, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = backupForGKEClient.CreateBackupPlan(parent, backupPlan, backupPlanId);

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

CreateBackupPlanAsync(LocationName, BackupPlan, string, CallSettings)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(LocationName parent, BackupPlan backupPlan, string backupPlanId, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(parent, backupPlan, backupPlanId);

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

CreateBackupPlanAsync(LocationName, BackupPlan, string, CancellationToken)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(LocationName parent, BackupPlan backupPlan, string backupPlanId, CancellationToken cancellationToken)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(parent, backupPlan, backupPlanId);

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

CreateBackupPlanAsync(CreateBackupPlanRequest, CallSettings)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(CreateBackupPlanRequest request, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
request CreateBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateBackupPlanRequest request = new CreateBackupPlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    BackupPlan = new BackupPlan(),
    BackupPlanId = "",
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(request);

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

CreateBackupPlanAsync(CreateBackupPlanRequest, CancellationToken)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(CreateBackupPlanRequest request, CancellationToken cancellationToken)

Creates a new BackupPlan in a given location.

Parameters
Name Description
request CreateBackupPlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateBackupPlanRequest request = new CreateBackupPlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    BackupPlan = new BackupPlan(),
    BackupPlanId = "",
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(request);

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

CreateBackupPlanAsync(string, BackupPlan, string, CallSettings)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(string parent, BackupPlan backupPlan, string backupPlanId, CallSettings callSettings = null)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(parent, backupPlan, backupPlanId);

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

CreateBackupPlanAsync(string, BackupPlan, string, CancellationToken)

public virtual Task<Operation<BackupPlan, OperationMetadata>> CreateBackupPlanAsync(string parent, BackupPlan backupPlan, string backupPlanId, CancellationToken cancellationToken)

Creates a new BackupPlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the BackupPlan. Format: projects/*/locations/*

backupPlan BackupPlan

Required. The BackupPlan resource object to create.

backupPlanId string

Required. The client-provided short name for the BackupPlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of BackupPlans in this location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
BackupPlan backupPlan = new BackupPlan();
string backupPlanId = "";
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.CreateBackupPlanAsync(parent, backupPlan, backupPlanId);

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

CreateRestore(CreateRestoreRequest, CallSettings)

public virtual Operation<Restore, OperationMetadata> CreateRestore(CreateRestoreRequest request, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
request CreateRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
CreateRestoreRequest request = new CreateRestoreRequest
{
    ParentAsRestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Restore = new Restore(),
    RestoreId = "",
};
// Make the request
Operation<Restore, OperationMetadata> response = backupForGKEClient.CreateRestore(request);

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

CreateRestore(RestorePlanName, Restore, string, CallSettings)

public virtual Operation<Restore, OperationMetadata> CreateRestore(RestorePlanName parent, Restore restore, string restoreId, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent RestorePlanName

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestorePlanName parent = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = backupForGKEClient.CreateRestore(parent, restore, restoreId);

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

CreateRestore(string, Restore, string, CallSettings)

public virtual Operation<Restore, OperationMetadata> CreateRestore(string parent, Restore restore, string restoreId, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent string

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = backupForGKEClient.CreateRestore(parent, restore, restoreId);

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

CreateRestoreAsync(CreateRestoreRequest, CallSettings)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(CreateRestoreRequest request, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
request CreateRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateRestoreRequest request = new CreateRestoreRequest
{
    ParentAsRestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Restore = new Restore(),
    RestoreId = "",
};
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(request);

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

CreateRestoreAsync(CreateRestoreRequest, CancellationToken)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(CreateRestoreRequest request, CancellationToken cancellationToken)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
request CreateRestoreRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateRestoreRequest request = new CreateRestoreRequest
{
    ParentAsRestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Restore = new Restore(),
    RestoreId = "",
};
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(request);

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

CreateRestoreAsync(RestorePlanName, Restore, string, CallSettings)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(RestorePlanName parent, Restore restore, string restoreId, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent RestorePlanName

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName parent = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(parent, restore, restoreId);

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

CreateRestoreAsync(RestorePlanName, Restore, string, CancellationToken)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(RestorePlanName parent, Restore restore, string restoreId, CancellationToken cancellationToken)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent RestorePlanName

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName parent = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(parent, restore, restoreId);

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

CreateRestoreAsync(string, Restore, string, CallSettings)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(string parent, Restore restore, string restoreId, CallSettings callSettings = null)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent string

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(parent, restore, restoreId);

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

CreateRestoreAsync(string, Restore, string, CancellationToken)

public virtual Task<Operation<Restore, OperationMetadata>> CreateRestoreAsync(string parent, Restore restore, string restoreId, CancellationToken cancellationToken)

Creates a new Restore for the given RestorePlan.

Parameters
Name Description
parent string

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

restore Restore

Required. The restore resource to create.

restoreId string

Required. The client-provided short name for the Restore resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of Restores in this RestorePlan.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
Restore restore = new Restore();
string restoreId = "";
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.CreateRestoreAsync(parent, restore, restoreId);

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

CreateRestorePlan(LocationName, RestorePlan, string, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> CreateRestorePlan(LocationName parent, RestorePlan restorePlan, string restorePlanId, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = backupForGKEClient.CreateRestorePlan(parent, restorePlan, restorePlanId);

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

CreateRestorePlan(CreateRestorePlanRequest, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> CreateRestorePlan(CreateRestorePlanRequest request, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
request CreateRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
CreateRestorePlanRequest request = new CreateRestorePlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    RestorePlan = new RestorePlan(),
    RestorePlanId = "",
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = backupForGKEClient.CreateRestorePlan(request);

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

CreateRestorePlan(string, RestorePlan, string, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> CreateRestorePlan(string parent, RestorePlan restorePlan, string restorePlanId, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = backupForGKEClient.CreateRestorePlan(parent, restorePlan, restorePlanId);

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

CreateRestorePlanAsync(LocationName, RestorePlan, string, CallSettings)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(LocationName parent, RestorePlan restorePlan, string restorePlanId, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(parent, restorePlan, restorePlanId);

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

CreateRestorePlanAsync(LocationName, RestorePlan, string, CancellationToken)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(LocationName parent, RestorePlan restorePlan, string restorePlanId, CancellationToken cancellationToken)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent LocationName

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(parent, restorePlan, restorePlanId);

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

CreateRestorePlanAsync(CreateRestorePlanRequest, CallSettings)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(CreateRestorePlanRequest request, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
request CreateRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateRestorePlanRequest request = new CreateRestorePlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    RestorePlan = new RestorePlan(),
    RestorePlanId = "",
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(request);

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

CreateRestorePlanAsync(CreateRestorePlanRequest, CancellationToken)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(CreateRestorePlanRequest request, CancellationToken cancellationToken)

Creates a new RestorePlan in a given location.

Parameters
Name Description
request CreateRestorePlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
CreateRestorePlanRequest request = new CreateRestorePlanRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    RestorePlan = new RestorePlan(),
    RestorePlanId = "",
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(request);

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

CreateRestorePlanAsync(string, RestorePlan, string, CallSettings)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(string parent, RestorePlan restorePlan, string restorePlanId, CallSettings callSettings = null)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(parent, restorePlan, restorePlanId);

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

CreateRestorePlanAsync(string, RestorePlan, string, CancellationToken)

public virtual Task<Operation<RestorePlan, OperationMetadata>> CreateRestorePlanAsync(string parent, RestorePlan restorePlan, string restorePlanId, CancellationToken cancellationToken)

Creates a new RestorePlan in a given location.

Parameters
Name Description
parent string

Required. The location within which to create the RestorePlan. Format: projects/*/locations/*

restorePlan RestorePlan

Required. The RestorePlan resource object to create.

restorePlanId string

Required. The client-provided short name for the RestorePlan resource. This name must:

  • be between 1 and 63 characters long (inclusive)
  • consist of only lower-case ASCII letters, numbers, and dashes
  • start with a lower-case letter
  • end with a lower-case letter or number
  • be unique within the set of RestorePlans in this location
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
RestorePlan restorePlan = new RestorePlan();
string restorePlanId = "";
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.CreateRestorePlanAsync(parent, restorePlan, restorePlanId);

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

DeleteBackup(BackupName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteBackup(BackupName name, CallSettings callSettings = null)

Deletes an existing Backup.

Parameters
Name Description
name BackupName

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackup(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 = backupForGKEClient.PollOnceDeleteBackup(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;
}

DeleteBackup(DeleteBackupRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes an existing Backup.

Parameters
Name Description
request DeleteBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackup(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 = backupForGKEClient.PollOnceDeleteBackup(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;
}

DeleteBackup(string, CallSettings)

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

Deletes an existing Backup.

Parameters
Name Description
name string

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackup(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 = backupForGKEClient.PollOnceDeleteBackup(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;
}

DeleteBackupAsync(BackupName, CallSettings)

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

Deletes an existing Backup.

Parameters
Name Description
name BackupName

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupAsync(BackupName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(BackupName name, CancellationToken cancellationToken)

Deletes an existing Backup.

Parameters
Name Description
name BackupName

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

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

Deletes an existing Backup.

Parameters
Name Description
request DeleteBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken)

Deletes an existing Backup.

Parameters
Name Description
request DeleteBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupRequest request = new DeleteBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupAsync(string, CallSettings)

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

Deletes an existing Backup.

Parameters
Name Description
name string

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupAsync(string, CancellationToken)

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

Deletes an existing Backup.

Parameters
Name Description
name string

Required. Name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupAsync(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 backupForGKEClient.PollOnceDeleteBackupAsync(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;
}

DeleteBackupPlan(BackupPlanName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteBackupPlan(BackupPlanName name, CallSettings callSettings = null)

Deletes an existing BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackupPlan(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 = backupForGKEClient.PollOnceDeleteBackupPlan(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;
}

DeleteBackupPlan(DeleteBackupPlanRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteBackupPlan(DeleteBackupPlanRequest request, CallSettings callSettings = null)

Deletes an existing BackupPlan.

Parameters
Name Description
request DeleteBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
DeleteBackupPlanRequest request = new DeleteBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackupPlan(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 = backupForGKEClient.PollOnceDeleteBackupPlan(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;
}

DeleteBackupPlan(string, CallSettings)

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

Deletes an existing BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteBackupPlan(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 = backupForGKEClient.PollOnceDeleteBackupPlan(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;
}

DeleteBackupPlanAsync(BackupPlanName, CallSettings)

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

Deletes an existing BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteBackupPlanAsync(BackupPlanName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteBackupPlanAsync(BackupPlanName name, CancellationToken cancellationToken)

Deletes an existing BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteBackupPlanAsync(DeleteBackupPlanRequest, CallSettings)

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

Deletes an existing BackupPlan.

Parameters
Name Description
request DeleteBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupPlanRequest request = new DeleteBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteBackupPlanAsync(DeleteBackupPlanRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteBackupPlanAsync(DeleteBackupPlanRequest request, CancellationToken cancellationToken)

Deletes an existing BackupPlan.

Parameters
Name Description
request DeleteBackupPlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteBackupPlanRequest request = new DeleteBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Etag = "",
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteBackupPlanAsync(string, CallSettings)

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

Deletes an existing BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteBackupPlanAsync(string, CancellationToken)

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

Deletes an existing BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteBackupPlanAsync(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 backupForGKEClient.PollOnceDeleteBackupPlanAsync(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;
}

DeleteRestore(DeleteRestoreRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRestore(DeleteRestoreRequest request, CallSettings callSettings = null)

Deletes an existing Restore.

Parameters
Name Description
request DeleteRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
DeleteRestoreRequest request = new DeleteRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestore(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 = backupForGKEClient.PollOnceDeleteRestore(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;
}

DeleteRestore(RestoreName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRestore(RestoreName name, CallSettings callSettings = null)

Deletes an existing Restore.

Parameters
Name Description
name RestoreName

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestore(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 = backupForGKEClient.PollOnceDeleteRestore(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;
}

DeleteRestore(string, CallSettings)

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

Deletes an existing Restore.

Parameters
Name Description
name string

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestore(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 = backupForGKEClient.PollOnceDeleteRestore(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;
}

DeleteRestoreAsync(DeleteRestoreRequest, CallSettings)

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

Deletes an existing Restore.

Parameters
Name Description
request DeleteRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteRestoreRequest request = new DeleteRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestoreAsync(DeleteRestoreRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRestoreAsync(DeleteRestoreRequest request, CancellationToken cancellationToken)

Deletes an existing Restore.

Parameters
Name Description
request DeleteRestoreRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteRestoreRequest request = new DeleteRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestoreAsync(RestoreName, CallSettings)

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

Deletes an existing Restore.

Parameters
Name Description
name RestoreName

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestoreAsync(RestoreName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRestoreAsync(RestoreName name, CancellationToken cancellationToken)

Deletes an existing Restore.

Parameters
Name Description
name RestoreName

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestoreAsync(string, CallSettings)

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

Deletes an existing Restore.

Parameters
Name Description
name string

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestoreAsync(string, CancellationToken)

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

Deletes an existing Restore.

Parameters
Name Description
name string

Required. Full name of the Restore Format: projects/*/locations/*/restorePlans/*/restores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestoreAsync(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 backupForGKEClient.PollOnceDeleteRestoreAsync(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;
}

DeleteRestorePlan(DeleteRestorePlanRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRestorePlan(DeleteRestorePlanRequest request, CallSettings callSettings = null)

Deletes an existing RestorePlan.

Parameters
Name Description
request DeleteRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
DeleteRestorePlanRequest request = new DeleteRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestorePlan(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 = backupForGKEClient.PollOnceDeleteRestorePlan(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;
}

DeleteRestorePlan(RestorePlanName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteRestorePlan(RestorePlanName name, CallSettings callSettings = null)

Deletes an existing RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestorePlan(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 = backupForGKEClient.PollOnceDeleteRestorePlan(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;
}

DeleteRestorePlan(string, CallSettings)

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

Deletes an existing RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = backupForGKEClient.DeleteRestorePlan(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 = backupForGKEClient.PollOnceDeleteRestorePlan(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;
}

DeleteRestorePlanAsync(DeleteRestorePlanRequest, CallSettings)

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

Deletes an existing RestorePlan.

Parameters
Name Description
request DeleteRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteRestorePlanRequest request = new DeleteRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

DeleteRestorePlanAsync(DeleteRestorePlanRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRestorePlanAsync(DeleteRestorePlanRequest request, CancellationToken cancellationToken)

Deletes an existing RestorePlan.

Parameters
Name Description
request DeleteRestorePlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
DeleteRestorePlanRequest request = new DeleteRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Etag = "",
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

DeleteRestorePlanAsync(RestorePlanName, CallSettings)

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

Deletes an existing RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

DeleteRestorePlanAsync(RestorePlanName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteRestorePlanAsync(RestorePlanName name, CancellationToken cancellationToken)

Deletes an existing RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

DeleteRestorePlanAsync(string, CallSettings)

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

Deletes an existing RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

DeleteRestorePlanAsync(string, CancellationToken)

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

Deletes an existing RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
Operation<Empty, OperationMetadata> response = await backupForGKEClient.DeleteRestorePlanAsync(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 backupForGKEClient.PollOnceDeleteRestorePlanAsync(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;
}

GetBackup(BackupName, CallSettings)

public virtual Backup GetBackup(BackupName name, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
name BackupName

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Backup response = backupForGKEClient.GetBackup(name);

GetBackup(GetBackupRequest, CallSettings)

public virtual Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
request GetBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
Backup response = backupForGKEClient.GetBackup(request);

GetBackup(string, CallSettings)

public virtual Backup GetBackup(string name, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
name string

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Backup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Backup response = backupForGKEClient.GetBackup(name);

GetBackupAsync(BackupName, CallSettings)

public virtual Task<Backup> GetBackupAsync(BackupName name, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
name BackupName

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(name);

GetBackupAsync(BackupName, CancellationToken)

public virtual Task<Backup> GetBackupAsync(BackupName name, CancellationToken cancellationToken)

Retrieve the details of a single Backup.

Parameters
Name Description
name BackupName

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName name = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(name);

GetBackupAsync(GetBackupRequest, CallSettings)

public virtual Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
request GetBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(request);

GetBackupAsync(GetBackupRequest, CancellationToken)

public virtual Task<Backup> GetBackupAsync(GetBackupRequest request, CancellationToken cancellationToken)

Retrieve the details of a single Backup.

Parameters
Name Description
request GetBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupRequest request = new GetBackupRequest
{
    BackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(request);

GetBackupAsync(string, CallSettings)

public virtual Task<Backup> GetBackupAsync(string name, CallSettings callSettings = null)

Retrieve the details of a single Backup.

Parameters
Name Description
name string

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(name);

GetBackupAsync(string, CancellationToken)

public virtual Task<Backup> GetBackupAsync(string name, CancellationToken cancellationToken)

Retrieve the details of a single Backup.

Parameters
Name Description
name string

Required. Full name of the Backup resource. Format: projects/*/locations/*/backupPlans/*/backups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
Backup response = await backupForGKEClient.GetBackupAsync(name);

GetBackupIndexDownloadUrl(BackupName, CallSettings)

public virtual GetBackupIndexDownloadUrlResponse GetBackupIndexDownloadUrl(BackupName backup, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup BackupName

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetBackupIndexDownloadUrlResponse

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupName backup = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
GetBackupIndexDownloadUrlResponse response = backupForGKEClient.GetBackupIndexDownloadUrl(backup);

GetBackupIndexDownloadUrl(GetBackupIndexDownloadUrlRequest, CallSettings)

public virtual GetBackupIndexDownloadUrlResponse GetBackupIndexDownloadUrl(GetBackupIndexDownloadUrlRequest request, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
request GetBackupIndexDownloadUrlRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetBackupIndexDownloadUrlResponse

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetBackupIndexDownloadUrlRequest request = new GetBackupIndexDownloadUrlRequest
{
    BackupAsBackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
GetBackupIndexDownloadUrlResponse response = backupForGKEClient.GetBackupIndexDownloadUrl(request);

GetBackupIndexDownloadUrl(string, CallSettings)

public virtual GetBackupIndexDownloadUrlResponse GetBackupIndexDownloadUrl(string backup, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup string

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
GetBackupIndexDownloadUrlResponse

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string backup = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
GetBackupIndexDownloadUrlResponse response = backupForGKEClient.GetBackupIndexDownloadUrl(backup);

GetBackupIndexDownloadUrlAsync(BackupName, CallSettings)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(BackupName backup, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup BackupName

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName backup = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(backup);

GetBackupIndexDownloadUrlAsync(BackupName, CancellationToken)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(BackupName backup, CancellationToken cancellationToken)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup BackupName

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName backup = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(backup);

GetBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest, CallSettings)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest request, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
request GetBackupIndexDownloadUrlRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupIndexDownloadUrlRequest request = new GetBackupIndexDownloadUrlRequest
{
    BackupAsBackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(request);

GetBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest, CancellationToken)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(GetBackupIndexDownloadUrlRequest request, CancellationToken cancellationToken)

Retrieve the link to the backupIndex.

Parameters
Name Description
request GetBackupIndexDownloadUrlRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupIndexDownloadUrlRequest request = new GetBackupIndexDownloadUrlRequest
{
    BackupAsBackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
};
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(request);

GetBackupIndexDownloadUrlAsync(string, CallSettings)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(string backup, CallSettings callSettings = null)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup string

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string backup = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(backup);

GetBackupIndexDownloadUrlAsync(string, CancellationToken)

public virtual Task<GetBackupIndexDownloadUrlResponse> GetBackupIndexDownloadUrlAsync(string backup, CancellationToken cancellationToken)

Retrieve the link to the backupIndex.

Parameters
Name Description
backup string

Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskGetBackupIndexDownloadUrlResponse

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string backup = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
GetBackupIndexDownloadUrlResponse response = await backupForGKEClient.GetBackupIndexDownloadUrlAsync(backup);

GetBackupPlan(BackupPlanName, CallSettings)

public virtual BackupPlan GetBackupPlan(BackupPlanName name, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupPlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
BackupPlan response = backupForGKEClient.GetBackupPlan(name);

GetBackupPlan(GetBackupPlanRequest, CallSettings)

public virtual BackupPlan GetBackupPlan(GetBackupPlanRequest request, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
request GetBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupPlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetBackupPlanRequest request = new GetBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
};
// Make the request
BackupPlan response = backupForGKEClient.GetBackupPlan(request);

GetBackupPlan(string, CallSettings)

public virtual BackupPlan GetBackupPlan(string name, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
BackupPlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
BackupPlan response = backupForGKEClient.GetBackupPlan(name);

GetBackupPlanAsync(BackupPlanName, CallSettings)

public virtual Task<BackupPlan> GetBackupPlanAsync(BackupPlanName name, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(name);

GetBackupPlanAsync(BackupPlanName, CancellationToken)

public virtual Task<BackupPlan> GetBackupPlanAsync(BackupPlanName name, CancellationToken cancellationToken)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name BackupPlanName

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName name = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(name);

GetBackupPlanAsync(GetBackupPlanRequest, CallSettings)

public virtual Task<BackupPlan> GetBackupPlanAsync(GetBackupPlanRequest request, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
request GetBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupPlanRequest request = new GetBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
};
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(request);

GetBackupPlanAsync(GetBackupPlanRequest, CancellationToken)

public virtual Task<BackupPlan> GetBackupPlanAsync(GetBackupPlanRequest request, CancellationToken cancellationToken)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
request GetBackupPlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetBackupPlanRequest request = new GetBackupPlanRequest
{
    BackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
};
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(request);

GetBackupPlanAsync(string, CallSettings)

public virtual Task<BackupPlan> GetBackupPlanAsync(string name, CallSettings callSettings = null)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(name);

GetBackupPlanAsync(string, CancellationToken)

public virtual Task<BackupPlan> GetBackupPlanAsync(string name, CancellationToken cancellationToken)

Retrieve the details of a single BackupPlan.

Parameters
Name Description
name string

Required. Fully qualified BackupPlan name. Format: projects/*/locations/*/backupPlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskBackupPlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
BackupPlan response = await backupForGKEClient.GetBackupPlanAsync(name);

GetRestore(GetRestoreRequest, CallSettings)

public virtual Restore GetRestore(GetRestoreRequest request, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
request GetRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Restore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetRestoreRequest request = new GetRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
};
// Make the request
Restore response = backupForGKEClient.GetRestore(request);

GetRestore(RestoreName, CallSettings)

public virtual Restore GetRestore(RestoreName name, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
name RestoreName

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Restore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Restore response = backupForGKEClient.GetRestore(name);

GetRestore(string, CallSettings)

public virtual Restore GetRestore(string name, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
name string

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Restore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Restore response = backupForGKEClient.GetRestore(name);

GetRestoreAsync(GetRestoreRequest, CallSettings)

public virtual Task<Restore> GetRestoreAsync(GetRestoreRequest request, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
request GetRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetRestoreRequest request = new GetRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
};
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(request);

GetRestoreAsync(GetRestoreRequest, CancellationToken)

public virtual Task<Restore> GetRestoreAsync(GetRestoreRequest request, CancellationToken cancellationToken)

Retrieves the details of a single Restore.

Parameters
Name Description
request GetRestoreRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetRestoreRequest request = new GetRestoreRequest
{
    RestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
};
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(request);

GetRestoreAsync(RestoreName, CallSettings)

public virtual Task<Restore> GetRestoreAsync(RestoreName name, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
name RestoreName

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(name);

GetRestoreAsync(RestoreName, CancellationToken)

public virtual Task<Restore> GetRestoreAsync(RestoreName name, CancellationToken cancellationToken)

Retrieves the details of a single Restore.

Parameters
Name Description
name RestoreName

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestoreName name = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(name);

GetRestoreAsync(string, CallSettings)

public virtual Task<Restore> GetRestoreAsync(string name, CallSettings callSettings = null)

Retrieves the details of a single Restore.

Parameters
Name Description
name string

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(name);

GetRestoreAsync(string, CancellationToken)

public virtual Task<Restore> GetRestoreAsync(string name, CancellationToken cancellationToken)

Retrieves the details of a single Restore.

Parameters
Name Description
name string

Required. Name of the restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
Restore response = await backupForGKEClient.GetRestoreAsync(name);

GetRestorePlan(GetRestorePlanRequest, CallSettings)

public virtual RestorePlan GetRestorePlan(GetRestorePlanRequest request, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
request GetRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RestorePlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetRestorePlanRequest request = new GetRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
};
// Make the request
RestorePlan response = backupForGKEClient.GetRestorePlan(request);

GetRestorePlan(RestorePlanName, CallSettings)

public virtual RestorePlan GetRestorePlan(RestorePlanName name, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RestorePlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
RestorePlan response = backupForGKEClient.GetRestorePlan(name);

GetRestorePlan(string, CallSettings)

public virtual RestorePlan GetRestorePlan(string name, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
RestorePlan

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
RestorePlan response = backupForGKEClient.GetRestorePlan(name);

GetRestorePlanAsync(GetRestorePlanRequest, CallSettings)

public virtual Task<RestorePlan> GetRestorePlanAsync(GetRestorePlanRequest request, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
request GetRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetRestorePlanRequest request = new GetRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
};
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(request);

GetRestorePlanAsync(GetRestorePlanRequest, CancellationToken)

public virtual Task<RestorePlan> GetRestorePlanAsync(GetRestorePlanRequest request, CancellationToken cancellationToken)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
request GetRestorePlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetRestorePlanRequest request = new GetRestorePlanRequest
{
    RestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
};
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(request);

GetRestorePlanAsync(RestorePlanName, CallSettings)

public virtual Task<RestorePlan> GetRestorePlanAsync(RestorePlanName name, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(name);

GetRestorePlanAsync(RestorePlanName, CancellationToken)

public virtual Task<RestorePlan> GetRestorePlanAsync(RestorePlanName name, CancellationToken cancellationToken)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name RestorePlanName

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName name = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(name);

GetRestorePlanAsync(string, CallSettings)

public virtual Task<RestorePlan> GetRestorePlanAsync(string name, CallSettings callSettings = null)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(name);

GetRestorePlanAsync(string, CancellationToken)

public virtual Task<RestorePlan> GetRestorePlanAsync(string name, CancellationToken cancellationToken)

Retrieve the details of a single RestorePlan.

Parameters
Name Description
name string

Required. Fully qualified RestorePlan name. Format: projects/*/locations/*/restorePlans/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskRestorePlan

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
RestorePlan response = await backupForGKEClient.GetRestorePlanAsync(name);

GetVolumeBackup(GetVolumeBackupRequest, CallSettings)

public virtual VolumeBackup GetVolumeBackup(GetVolumeBackupRequest request, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
request GetVolumeBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeBackup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetVolumeBackupRequest request = new GetVolumeBackupRequest
{
    VolumeBackupName = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]"),
};
// Make the request
VolumeBackup response = backupForGKEClient.GetVolumeBackup(request);

GetVolumeBackup(VolumeBackupName, CallSettings)

public virtual VolumeBackup GetVolumeBackup(VolumeBackupName name, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name VolumeBackupName

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeBackup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
VolumeBackupName name = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]");
// Make the request
VolumeBackup response = backupForGKEClient.GetVolumeBackup(name);

GetVolumeBackup(string, CallSettings)

public virtual VolumeBackup GetVolumeBackup(string name, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name string

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeBackup

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]/volumeBackups/[VOLUME_BACKUP]";
// Make the request
VolumeBackup response = backupForGKEClient.GetVolumeBackup(name);

GetVolumeBackupAsync(GetVolumeBackupRequest, CallSettings)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(GetVolumeBackupRequest request, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
request GetVolumeBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetVolumeBackupRequest request = new GetVolumeBackupRequest
{
    VolumeBackupName = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]"),
};
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(request);

GetVolumeBackupAsync(GetVolumeBackupRequest, CancellationToken)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(GetVolumeBackupRequest request, CancellationToken cancellationToken)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
request GetVolumeBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetVolumeBackupRequest request = new GetVolumeBackupRequest
{
    VolumeBackupName = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]"),
};
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(request);

GetVolumeBackupAsync(VolumeBackupName, CallSettings)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(VolumeBackupName name, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name VolumeBackupName

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
VolumeBackupName name = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]");
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(name);

GetVolumeBackupAsync(VolumeBackupName, CancellationToken)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(VolumeBackupName name, CancellationToken cancellationToken)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name VolumeBackupName

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
VolumeBackupName name = VolumeBackupName.FromProjectLocationBackupPlanBackupVolumeBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]");
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(name);

GetVolumeBackupAsync(string, CallSettings)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(string name, CallSettings callSettings = null)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name string

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]/volumeBackups/[VOLUME_BACKUP]";
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(name);

GetVolumeBackupAsync(string, CancellationToken)

public virtual Task<VolumeBackup> GetVolumeBackupAsync(string name, CancellationToken cancellationToken)

Retrieve the details of a single VolumeBackup.

Parameters
Name Description
name string

Required. Full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeBackup

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]/volumeBackups/[VOLUME_BACKUP]";
// Make the request
VolumeBackup response = await backupForGKEClient.GetVolumeBackupAsync(name);

GetVolumeRestore(GetVolumeRestoreRequest, CallSettings)

public virtual VolumeRestore GetVolumeRestore(GetVolumeRestoreRequest request, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
request GetVolumeRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeRestore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
GetVolumeRestoreRequest request = new GetVolumeRestoreRequest
{
    VolumeRestoreName = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]"),
};
// Make the request
VolumeRestore response = backupForGKEClient.GetVolumeRestore(request);

GetVolumeRestore(VolumeRestoreName, CallSettings)

public virtual VolumeRestore GetVolumeRestore(VolumeRestoreName name, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name VolumeRestoreName

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeRestore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
VolumeRestoreName name = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]");
// Make the request
VolumeRestore response = backupForGKEClient.GetVolumeRestore(name);

GetVolumeRestore(string, CallSettings)

public virtual VolumeRestore GetVolumeRestore(string name, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name string

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
VolumeRestore

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]/volumeRestores/[VOLUME_RESTORE]";
// Make the request
VolumeRestore response = backupForGKEClient.GetVolumeRestore(name);

GetVolumeRestoreAsync(GetVolumeRestoreRequest, CallSettings)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(GetVolumeRestoreRequest request, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
request GetVolumeRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetVolumeRestoreRequest request = new GetVolumeRestoreRequest
{
    VolumeRestoreName = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]"),
};
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(request);

GetVolumeRestoreAsync(GetVolumeRestoreRequest, CancellationToken)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(GetVolumeRestoreRequest request, CancellationToken cancellationToken)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
request GetVolumeRestoreRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
GetVolumeRestoreRequest request = new GetVolumeRestoreRequest
{
    VolumeRestoreName = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]"),
};
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(request);

GetVolumeRestoreAsync(VolumeRestoreName, CallSettings)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(VolumeRestoreName name, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name VolumeRestoreName

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
VolumeRestoreName name = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]");
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(name);

GetVolumeRestoreAsync(VolumeRestoreName, CancellationToken)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(VolumeRestoreName name, CancellationToken cancellationToken)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name VolumeRestoreName

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
VolumeRestoreName name = VolumeRestoreName.FromProjectLocationRestorePlanRestoreVolumeRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]");
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(name);

GetVolumeRestoreAsync(string, CallSettings)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(string name, CallSettings callSettings = null)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name string

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]/volumeRestores/[VOLUME_RESTORE]";
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(name);

GetVolumeRestoreAsync(string, CancellationToken)

public virtual Task<VolumeRestore> GetVolumeRestoreAsync(string name, CancellationToken cancellationToken)

Retrieve the details of a single VolumeRestore.

Parameters
Name Description
name string

Required. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskVolumeRestore

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]/volumeRestores/[VOLUME_RESTORE]";
// Make the request
VolumeRestore response = await backupForGKEClient.GetVolumeRestoreAsync(name);

ListBackupPlans(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlans(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
parent LocationName

Required. The location that contains the BackupPlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupPlansResponseBackupPlan

A pageable sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlans(parent);

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

ListBackupPlans(ListBackupPlansRequest, CallSettings)

public virtual PagedEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlans(ListBackupPlansRequest request, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
request ListBackupPlansRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupPlansResponseBackupPlan

A pageable sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListBackupPlansRequest request = new ListBackupPlansRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlans(request);

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

ListBackupPlans(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlans(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
parent string

Required. The location that contains the BackupPlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupPlansResponseBackupPlan

A pageable sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlans(parent);

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

ListBackupPlansAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlansAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
parent LocationName

Required. The location that contains the BackupPlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupPlansResponseBackupPlan

A pageable asynchronous sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlansAsync(parent);

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

ListBackupPlansAsync(ListBackupPlansRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlansAsync(ListBackupPlansRequest request, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
request ListBackupPlansRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupPlansResponseBackupPlan

A pageable asynchronous sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListBackupPlansRequest request = new ListBackupPlansRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlansAsync(request);

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

ListBackupPlansAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> ListBackupPlansAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists BackupPlans in a given location.

Parameters
Name Description
parent string

Required. The location that contains the BackupPlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupPlansResponseBackupPlan

A pageable asynchronous sequence of BackupPlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListBackupPlansResponse, BackupPlan> response = backupForGKEClient.ListBackupPlansAsync(parent);

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

ListBackups(BackupPlanName, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(BackupPlanName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
parent BackupPlanName

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupPlanName parent = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackups(parent);

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

ListBackups(ListBackupsRequest, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
request ListBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsBackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackups(request);

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

ListBackups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListBackupsResponse, Backup> ListBackups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
parent string

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListBackupsResponseBackup

A pageable sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
PagedEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackups(parent);

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

ListBackupsAsync(BackupPlanName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(BackupPlanName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
parent BackupPlanName

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlanName parent = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackupsAsync(parent);

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

ListBackupsAsync(ListBackupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
request ListBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListBackupsRequest request = new ListBackupsRequest
{
    ParentAsBackupPlanName = BackupPlanName.FromProjectLocationBackupPlan("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackupsAsync(request);

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

ListBackupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListBackupsResponse, Backup> ListBackupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Backups for a given BackupPlan.

Parameters
Name Description
parent string

Required. The BackupPlan that contains the Backups to list. Format: projects/*/locations/*/backupPlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListBackupsResponseBackup

A pageable asynchronous sequence of Backup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]";
// Make the request
PagedAsyncEnumerable<ListBackupsResponse, Backup> response = backupForGKEClient.ListBackupsAsync(parent);

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

ListRestorePlans(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlans(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
parent LocationName

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestorePlansResponseRestorePlan

A pageable sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlans(parent);

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

ListRestorePlans(ListRestorePlansRequest, CallSettings)

public virtual PagedEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlans(ListRestorePlansRequest request, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
request ListRestorePlansRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestorePlansResponseRestorePlan

A pageable sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListRestorePlansRequest request = new ListRestorePlansRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlans(request);

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

ListRestorePlans(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlans(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
parent string

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestorePlansResponseRestorePlan

A pageable sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlans(parent);

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

ListRestorePlansAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlansAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
parent LocationName

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestorePlansResponseRestorePlan

A pageable asynchronous sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlansAsync(parent);

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

ListRestorePlansAsync(ListRestorePlansRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlansAsync(ListRestorePlansRequest request, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
request ListRestorePlansRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestorePlansResponseRestorePlan

A pageable asynchronous sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListRestorePlansRequest request = new ListRestorePlansRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlansAsync(request);

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

ListRestorePlansAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> ListRestorePlansAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists RestorePlans in a given location.

Parameters
Name Description
parent string

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestorePlansResponseRestorePlan

A pageable asynchronous sequence of RestorePlan resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListRestorePlansResponse, RestorePlan> response = backupForGKEClient.ListRestorePlansAsync(parent);

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

ListRestores(ListRestoresRequest, CallSettings)

public virtual PagedEnumerable<ListRestoresResponse, Restore> ListRestores(ListRestoresRequest request, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
request ListRestoresRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestoresResponseRestore

A pageable sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListRestoresRequest request = new ListRestoresRequest
{
    ParentAsRestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestores(request);

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

ListRestores(RestorePlanName, string, int?, CallSettings)

public virtual PagedEnumerable<ListRestoresResponse, Restore> ListRestores(RestorePlanName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
parent RestorePlanName

Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestoresResponseRestore

A pageable sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestorePlanName parent = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
PagedEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestores(parent);

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

ListRestores(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListRestoresResponse, Restore> ListRestores(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
parent string

Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListRestoresResponseRestore

A pageable sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
PagedEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestores(parent);

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

ListRestoresAsync(ListRestoresRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListRestoresResponse, Restore> ListRestoresAsync(ListRestoresRequest request, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
request ListRestoresRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestoresResponseRestore

A pageable asynchronous sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListRestoresRequest request = new ListRestoresRequest
{
    ParentAsRestorePlanName = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestoresAsync(request);

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

ListRestoresAsync(RestorePlanName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRestoresResponse, Restore> ListRestoresAsync(RestorePlanName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
parent RestorePlanName

Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestoresResponseRestore

A pageable asynchronous sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlanName parent = RestorePlanName.FromProjectLocationRestorePlan("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
// Make the request
PagedAsyncEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestoresAsync(parent);

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

ListRestoresAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListRestoresResponse, Restore> ListRestoresAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the Restores for a given RestorePlan.

Parameters
Name Description
parent string

Required. The RestorePlan that contains the Restores to list. Format: projects/*/locations/*/restorePlans/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListRestoresResponseRestore

A pageable asynchronous sequence of Restore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]";
// Make the request
PagedAsyncEnumerable<ListRestoresResponse, Restore> response = backupForGKEClient.ListRestoresAsync(parent);

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

ListVolumeBackups(BackupName, string, int?, CallSettings)

public virtual PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackups(BackupName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
parent BackupName

Required. The Backup that contains the VolumeBackups to list. Format: projects/*/locations/*/backupPlans/*/backups/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeBackupsResponseVolumeBackup

A pageable sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupName parent = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackups(parent);

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

ListVolumeBackups(ListVolumeBackupsRequest, CallSettings)

public virtual PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackups(ListVolumeBackupsRequest request, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
request ListVolumeBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeBackupsResponseVolumeBackup

A pageable sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListVolumeBackupsRequest request = new ListVolumeBackupsRequest
{
    ParentAsBackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackups(request);

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

ListVolumeBackups(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackups(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
parent string

Required. The Backup that contains the VolumeBackups to list. Format: projects/*/locations/*/backupPlans/*/backups/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeBackupsResponseVolumeBackup

A pageable sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
PagedEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackups(parent);

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

ListVolumeBackupsAsync(BackupName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackupsAsync(BackupName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
parent BackupName

Required. The Backup that contains the VolumeBackups to list. Format: projects/*/locations/*/backupPlans/*/backups/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeBackupsResponseVolumeBackup

A pageable asynchronous sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupName parent = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
// Make the request
PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackupsAsync(parent);

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

ListVolumeBackupsAsync(ListVolumeBackupsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackupsAsync(ListVolumeBackupsRequest request, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
request ListVolumeBackupsRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeBackupsResponseVolumeBackup

A pageable asynchronous sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListVolumeBackupsRequest request = new ListVolumeBackupsRequest
{
    ParentAsBackupName = BackupName.FromProjectLocationBackupPlanBackup("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackupsAsync(request);

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

ListVolumeBackupsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> ListVolumeBackupsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeBackups for a given Backup.

Parameters
Name Description
parent string

Required. The Backup that contains the VolumeBackups to list. Format: projects/*/locations/*/backupPlans/*/backups/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeBackupsResponseVolumeBackup

A pageable asynchronous sequence of VolumeBackup resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/backupPlans/[BACKUP_PLAN]/backups/[BACKUP]";
// Make the request
PagedAsyncEnumerable<ListVolumeBackupsResponse, VolumeBackup> response = backupForGKEClient.ListVolumeBackupsAsync(parent);

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

ListVolumeRestores(ListVolumeRestoresRequest, CallSettings)

public virtual PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestores(ListVolumeRestoresRequest request, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
request ListVolumeRestoresRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeRestoresResponseVolumeRestore

A pageable sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
ListVolumeRestoresRequest request = new ListVolumeRestoresRequest
{
    ParentAsRestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestores(request);

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

ListVolumeRestores(RestoreName, string, int?, CallSettings)

public virtual PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestores(RestoreName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
parent RestoreName

Required. The Restore that contains the VolumeRestores to list. Format: projects/*/locations/*/restorePlans/*/restores/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeRestoresResponseVolumeRestore

A pageable sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestoreName parent = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestores(parent);

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

ListVolumeRestores(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestores(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
parent string

Required. The Restore that contains the VolumeRestores to list. Format: projects/*/locations/*/restorePlans/*/restores/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListVolumeRestoresResponseVolumeRestore

A pageable sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
PagedEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestores(parent);

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

ListVolumeRestoresAsync(ListVolumeRestoresRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestoresAsync(ListVolumeRestoresRequest request, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
request ListVolumeRestoresRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeRestoresResponseVolumeRestore

A pageable asynchronous sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
ListVolumeRestoresRequest request = new ListVolumeRestoresRequest
{
    ParentAsRestoreName = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]"),
    Filter = "",
    OrderBy = "",
};
// Make the request
PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestoresAsync(request);

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

ListVolumeRestoresAsync(RestoreName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestoresAsync(RestoreName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
parent RestoreName

Required. The Restore that contains the VolumeRestores to list. Format: projects/*/locations/*/restorePlans/*/restores/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeRestoresResponseVolumeRestore

A pageable asynchronous sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestoreName parent = RestoreName.FromProjectLocationRestorePlanRestore("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
// Make the request
PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestoresAsync(parent);

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

ListVolumeRestoresAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> ListVolumeRestoresAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the VolumeRestores for a given Restore.

Parameters
Name Description
parent string

Required. The Restore that contains the VolumeRestores to list. Format: projects/*/locations/*/restorePlans/*/restores/*

pageToken string

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

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListVolumeRestoresResponseVolumeRestore

A pageable asynchronous sequence of VolumeRestore resources.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/restorePlans/[RESTORE_PLAN]/restores/[RESTORE]";
// Make the request
PagedAsyncEnumerable<ListVolumeRestoresResponse, VolumeRestore> response = backupForGKEClient.ListVolumeRestoresAsync(parent);

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

PollOnceCreateBackup(string, CallSettings)

public virtual Operation<Backup, OperationMetadata> PollOnceCreateBackup(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The result of polling the operation.

PollOnceCreateBackupAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateBackupPlan(string, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> PollOnceCreateBackupPlan(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The result of polling the operation.

PollOnceCreateBackupPlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateRestore(string, CallSettings)

public virtual Operation<Restore, OperationMetadata> PollOnceCreateRestore(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The result of polling the operation.

PollOnceCreateRestoreAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A task representing the result of polling the operation.

PollOnceCreateRestorePlan(string, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> PollOnceCreateRestorePlan(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The result of polling the operation.

PollOnceCreateRestorePlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteBackup(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteBackupAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteBackupPlan(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteBackupPlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteRestore(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteRestoreAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceDeleteRestorePlan(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyOperationMetadata

The result of polling the operation.

PollOnceDeleteRestorePlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateBackup(string, CallSettings)

public virtual Operation<Backup, OperationMetadata> PollOnceUpdateBackup(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The result of polling the operation.

PollOnceUpdateBackupAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateBackupPlan(string, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> PollOnceUpdateBackupPlan(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The result of polling the operation.

PollOnceUpdateBackupPlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateRestore(string, CallSettings)

public virtual Operation<Restore, OperationMetadata> PollOnceUpdateRestore(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The result of polling the operation.

PollOnceUpdateRestoreAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A task representing the result of polling the operation.

PollOnceUpdateRestorePlan(string, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> PollOnceUpdateRestorePlan(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The result of polling the operation.

PollOnceUpdateRestorePlanAsync(string, CallSettings)

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

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

Parameters
Name Description
operationName string

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

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

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

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

UpdateBackup(Backup, FieldMask, CallSettings)

public virtual Operation<Backup, OperationMetadata> UpdateBackup(Backup backup, FieldMask updateMask, CallSettings callSettings = null)

Update a Backup.

Parameters
Name Description
backup Backup

Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Backup, OperationMetadata> response = backupForGKEClient.UpdateBackup(backup, updateMask);

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

UpdateBackup(UpdateBackupRequest, CallSettings)

public virtual Operation<Backup, OperationMetadata> UpdateBackup(UpdateBackupRequest request, CallSettings callSettings = null)

Update a Backup.

Parameters
Name Description
request UpdateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
    Backup = new Backup(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Backup, OperationMetadata> response = backupForGKEClient.UpdateBackup(request);

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

UpdateBackupAsync(Backup, FieldMask, CallSettings)

public virtual Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(Backup backup, FieldMask updateMask, CallSettings callSettings = null)

Update a Backup.

Parameters
Name Description
backup Backup

Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.UpdateBackupAsync(backup, updateMask);

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

UpdateBackupAsync(Backup, FieldMask, CancellationToken)

public virtual Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(Backup backup, FieldMask updateMask, CancellationToken cancellationToken)

Update a Backup.

Parameters
Name Description
backup Backup

Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in backup will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup are ignored and are not used to update the target Backup.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
Backup backup = new Backup();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.UpdateBackupAsync(backup, updateMask);

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

UpdateBackupAsync(UpdateBackupRequest, CallSettings)

public virtual Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(UpdateBackupRequest request, CallSettings callSettings = null)

Update a Backup.

Parameters
Name Description
request UpdateBackupRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
    Backup = new Backup(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.UpdateBackupAsync(request);

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

UpdateBackupAsync(UpdateBackupRequest, CancellationToken)

public virtual Task<Operation<Backup, OperationMetadata>> UpdateBackupAsync(UpdateBackupRequest request, CancellationToken cancellationToken)

Update a Backup.

Parameters
Name Description
request UpdateBackupRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupRequest request = new UpdateBackupRequest
{
    Backup = new Backup(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Backup, OperationMetadata> response = await backupForGKEClient.UpdateBackupAsync(request);

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

UpdateBackupPlan(BackupPlan, FieldMask, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> UpdateBackupPlan(BackupPlan backupPlan, FieldMask updateMask, CallSettings callSettings = null)

Update a BackupPlan.

Parameters
Name Description
backupPlan BackupPlan

Required. A new version of the BackupPlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
BackupPlan backupPlan = new BackupPlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<BackupPlan, OperationMetadata> response = backupForGKEClient.UpdateBackupPlan(backupPlan, updateMask);

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

UpdateBackupPlan(UpdateBackupPlanRequest, CallSettings)

public virtual Operation<BackupPlan, OperationMetadata> UpdateBackupPlan(UpdateBackupPlanRequest request, CallSettings callSettings = null)

Update a BackupPlan.

Parameters
Name Description
request UpdateBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBackupPlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
UpdateBackupPlanRequest request = new UpdateBackupPlanRequest
{
    BackupPlan = new BackupPlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = backupForGKEClient.UpdateBackupPlan(request);

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

UpdateBackupPlanAsync(BackupPlan, FieldMask, CallSettings)

public virtual Task<Operation<BackupPlan, OperationMetadata>> UpdateBackupPlanAsync(BackupPlan backupPlan, FieldMask updateMask, CallSettings callSettings = null)

Update a BackupPlan.

Parameters
Name Description
backupPlan BackupPlan

Required. A new version of the BackupPlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlan backupPlan = new BackupPlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.UpdateBackupPlanAsync(backupPlan, updateMask);

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

UpdateBackupPlanAsync(BackupPlan, FieldMask, CancellationToken)

public virtual Task<Operation<BackupPlan, OperationMetadata>> UpdateBackupPlanAsync(BackupPlan backupPlan, FieldMask updateMask, CancellationToken cancellationToken)

Update a BackupPlan.

Parameters
Name Description
backupPlan BackupPlan

Required. A new version of the BackupPlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the backup_plan provided with this request. Field names are relative to the root of the resource (e.g., description, backup_config.include_volume_data, etc.) If no update_mask is provided, all fields in backup_plan will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in backup_plan are ignored and are not used to update the target BackupPlan.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
BackupPlan backupPlan = new BackupPlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.UpdateBackupPlanAsync(backupPlan, updateMask);

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

UpdateBackupPlanAsync(UpdateBackupPlanRequest, CallSettings)

public virtual Task<Operation<BackupPlan, OperationMetadata>> UpdateBackupPlanAsync(UpdateBackupPlanRequest request, CallSettings callSettings = null)

Update a BackupPlan.

Parameters
Name Description
request UpdateBackupPlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupPlanRequest request = new UpdateBackupPlanRequest
{
    BackupPlan = new BackupPlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.UpdateBackupPlanAsync(request);

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

UpdateBackupPlanAsync(UpdateBackupPlanRequest, CancellationToken)

public virtual Task<Operation<BackupPlan, OperationMetadata>> UpdateBackupPlanAsync(UpdateBackupPlanRequest request, CancellationToken cancellationToken)

Update a BackupPlan.

Parameters
Name Description
request UpdateBackupPlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBackupPlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateBackupPlanRequest request = new UpdateBackupPlanRequest
{
    BackupPlan = new BackupPlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BackupPlan, OperationMetadata> response = await backupForGKEClient.UpdateBackupPlanAsync(request);

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

UpdateRestore(Restore, FieldMask, CallSettings)

public virtual Operation<Restore, OperationMetadata> UpdateRestore(Restore restore, FieldMask updateMask, CallSettings callSettings = null)

Update a Restore.

Parameters
Name Description
restore Restore

Required. A new version of the Restore resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the restore provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore are ignored and are not used to update the target Restore.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
Restore restore = new Restore();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Restore, OperationMetadata> response = backupForGKEClient.UpdateRestore(restore, updateMask);

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

UpdateRestore(UpdateRestoreRequest, CallSettings)

public virtual Operation<Restore, OperationMetadata> UpdateRestore(UpdateRestoreRequest request, CallSettings callSettings = null)

Update a Restore.

Parameters
Name Description
request UpdateRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestoreOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
UpdateRestoreRequest request = new UpdateRestoreRequest
{
    Restore = new Restore(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Restore, OperationMetadata> response = backupForGKEClient.UpdateRestore(request);

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

UpdateRestoreAsync(Restore, FieldMask, CallSettings)

public virtual Task<Operation<Restore, OperationMetadata>> UpdateRestoreAsync(Restore restore, FieldMask updateMask, CallSettings callSettings = null)

Update a Restore.

Parameters
Name Description
restore Restore

Required. A new version of the Restore resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the restore provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore are ignored and are not used to update the target Restore.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
Restore restore = new Restore();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.UpdateRestoreAsync(restore, updateMask);

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

UpdateRestoreAsync(Restore, FieldMask, CancellationToken)

public virtual Task<Operation<Restore, OperationMetadata>> UpdateRestoreAsync(Restore restore, FieldMask updateMask, CancellationToken cancellationToken)

Update a Restore.

Parameters
Name Description
restore Restore

Required. A new version of the Restore resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the restore provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore are ignored and are not used to update the target Restore.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
Restore restore = new Restore();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.UpdateRestoreAsync(restore, updateMask);

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

UpdateRestoreAsync(UpdateRestoreRequest, CallSettings)

public virtual Task<Operation<Restore, OperationMetadata>> UpdateRestoreAsync(UpdateRestoreRequest request, CallSettings callSettings = null)

Update a Restore.

Parameters
Name Description
request UpdateRestoreRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateRestoreRequest request = new UpdateRestoreRequest
{
    Restore = new Restore(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.UpdateRestoreAsync(request);

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

UpdateRestoreAsync(UpdateRestoreRequest, CancellationToken)

public virtual Task<Operation<Restore, OperationMetadata>> UpdateRestoreAsync(UpdateRestoreRequest request, CancellationToken cancellationToken)

Update a Restore.

Parameters
Name Description
request UpdateRestoreRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestoreOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateRestoreRequest request = new UpdateRestoreRequest
{
    Restore = new Restore(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Restore, OperationMetadata> response = await backupForGKEClient.UpdateRestoreAsync(request);

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

UpdateRestorePlan(RestorePlan, FieldMask, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> UpdateRestorePlan(RestorePlan restorePlan, FieldMask updateMask, CallSettings callSettings = null)

Update a RestorePlan.

Parameters
Name Description
restorePlan RestorePlan

Required. A new version of the RestorePlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the restore_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore_plan will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_plan are ignored and are not used to update the target RestorePlan.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
RestorePlan restorePlan = new RestorePlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<RestorePlan, OperationMetadata> response = backupForGKEClient.UpdateRestorePlan(restorePlan, updateMask);

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

UpdateRestorePlan(UpdateRestorePlanRequest, CallSettings)

public virtual Operation<RestorePlan, OperationMetadata> UpdateRestorePlan(UpdateRestorePlanRequest request, CallSettings callSettings = null)

Update a RestorePlan.

Parameters
Name Description
request UpdateRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationRestorePlanOperationMetadata

The RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = BackupForGKEClient.Create();
// Initialize request argument(s)
UpdateRestorePlanRequest request = new UpdateRestorePlanRequest
{
    RestorePlan = new RestorePlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = backupForGKEClient.UpdateRestorePlan(request);

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

UpdateRestorePlanAsync(RestorePlan, FieldMask, CallSettings)

public virtual Task<Operation<RestorePlan, OperationMetadata>> UpdateRestorePlanAsync(RestorePlan restorePlan, FieldMask updateMask, CallSettings callSettings = null)

Update a RestorePlan.

Parameters
Name Description
restorePlan RestorePlan

Required. A new version of the RestorePlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the restore_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore_plan will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_plan are ignored and are not used to update the target RestorePlan.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlan restorePlan = new RestorePlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.UpdateRestorePlanAsync(restorePlan, updateMask);

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

UpdateRestorePlanAsync(RestorePlan, FieldMask, CancellationToken)

public virtual Task<Operation<RestorePlan, OperationMetadata>> UpdateRestorePlanAsync(RestorePlan restorePlan, FieldMask updateMask, CancellationToken cancellationToken)

Update a RestorePlan.

Parameters
Name Description
restorePlan RestorePlan

Required. A new version of the RestorePlan resource that contains updated fields. This may be sparsely populated if an update_mask is provided.

updateMask FieldMask

Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the restore_plan provided with this request. Field names are relative to the root of the resource. If no update_mask is provided, all fields in restore_plan will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in restore_plan are ignored and are not used to update the target RestorePlan.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
RestorePlan restorePlan = new RestorePlan();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.UpdateRestorePlanAsync(restorePlan, updateMask);

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

UpdateRestorePlanAsync(UpdateRestorePlanRequest, CallSettings)

public virtual Task<Operation<RestorePlan, OperationMetadata>> UpdateRestorePlanAsync(UpdateRestorePlanRequest request, CallSettings callSettings = null)

Update a RestorePlan.

Parameters
Name Description
request UpdateRestorePlanRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateRestorePlanRequest request = new UpdateRestorePlanRequest
{
    RestorePlan = new RestorePlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.UpdateRestorePlanAsync(request);

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

UpdateRestorePlanAsync(UpdateRestorePlanRequest, CancellationToken)

public virtual Task<Operation<RestorePlan, OperationMetadata>> UpdateRestorePlanAsync(UpdateRestorePlanRequest request, CancellationToken cancellationToken)

Update a RestorePlan.

Parameters
Name Description
request UpdateRestorePlanRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationRestorePlanOperationMetadata

A Task containing the RPC response.

Example
// Create client
BackupForGKEClient backupForGKEClient = await BackupForGKEClient.CreateAsync();
// Initialize request argument(s)
UpdateRestorePlanRequest request = new UpdateRestorePlanRequest
{
    RestorePlan = new RestorePlan(),
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<RestorePlan, OperationMetadata> response = await backupForGKEClient.UpdateRestorePlanAsync(request);

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