Backup and DR Service v1 API - Class BackupDR.BackupDRBase (1.2.0)

[BindServiceMethod(typeof(BackupDR), "BindService")]
public abstract class BackupDR.BackupDRBase

Reference documentation and code samples for the Backup and DR Service v1 API class BackupDR.BackupDRBase.

Base class for server-side implementations of BackupDR

Inheritance

object > BackupDR.BackupDRBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Methods

AbandonBackup(AbandonBackupRequest, ServerCallContext)

public virtual Task<Operation> AbandonBackup(AbandonBackupRequest request, ServerCallContext context)

Internal only. Abandons a backup.

Parameters
Name	Description
`request`	`AbandonBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateBackupPlan(CreateBackupPlanRequest, ServerCallContext)

public virtual Task<Operation> CreateBackupPlan(CreateBackupPlanRequest request, ServerCallContext context)

Create a BackupPlan

Parameters
Name	Description
`request`	`CreateBackupPlanRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateBackupPlanAssociation(CreateBackupPlanAssociationRequest, ServerCallContext)

public virtual Task<Operation> CreateBackupPlanAssociation(CreateBackupPlanAssociationRequest request, ServerCallContext context)

Create a BackupPlanAssociation

Parameters
Name	Description
`request`	`CreateBackupPlanAssociationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateBackupVault(CreateBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> CreateBackupVault(CreateBackupVaultRequest request, ServerCallContext context)

Creates a new BackupVault in a given project and location.

Parameters
Name	Description
`request`	`CreateBackupVaultRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateManagementServer(CreateManagementServerRequest, ServerCallContext)

public virtual Task<Operation> CreateManagementServer(CreateManagementServerRequest request, ServerCallContext context)

Creates a new ManagementServer in a given project and location.

Parameters
Name	Description
`request`	`CreateManagementServerRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Deletes a Backup.

Parameters
Name	Description
`request`	`DeleteBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteBackupPlan(DeleteBackupPlanRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackupPlan(DeleteBackupPlanRequest request, ServerCallContext context)

Deletes a single BackupPlan.

Parameters
Name	Description
`request`	`DeleteBackupPlanRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteBackupPlanAssociation(DeleteBackupPlanAssociationRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackupPlanAssociation(DeleteBackupPlanAssociationRequest request, ServerCallContext context)

Deletes a single BackupPlanAssociation.

Parameters
Name	Description
`request`	`DeleteBackupPlanAssociationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteBackupVault(DeleteBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackupVault(DeleteBackupVaultRequest request, ServerCallContext context)

Deletes a BackupVault.

Parameters
Name	Description
`request`	`DeleteBackupVaultRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteManagementServer(DeleteManagementServerRequest, ServerCallContext)

public virtual Task<Operation> DeleteManagementServer(DeleteManagementServerRequest request, ServerCallContext context)

Deletes a single ManagementServer.

Parameters
Name	Description
`request`	`DeleteManagementServerRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

FetchAccessToken(FetchAccessTokenRequest, ServerCallContext)

public virtual Task<FetchAccessTokenResponse> FetchAccessToken(FetchAccessTokenRequest request, ServerCallContext context)

Internal only. Fetch access token for a given data source.

Parameters
Name	Description
`request`	`FetchAccessTokenRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskFetchAccessTokenResponse`	The response to send back to the client (wrapped by a task).

FetchUsableBackupVaults(FetchUsableBackupVaultsRequest, ServerCallContext)

public virtual Task<FetchUsableBackupVaultsResponse> FetchUsableBackupVaults(FetchUsableBackupVaultsRequest request, ServerCallContext context)

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.

Parameters
Name	Description
`request`	`FetchUsableBackupVaultsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskFetchUsableBackupVaultsResponse`	The response to send back to the client (wrapped by a task).

FinalizeBackup(FinalizeBackupRequest, ServerCallContext)

public virtual Task<Operation> FinalizeBackup(FinalizeBackupRequest request, ServerCallContext context)

Internal only. Finalize a backup that was started by a call to InitiateBackup.

Parameters
Name	Description
`request`	`FinalizeBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Gets details of a Backup.

Parameters
Name	Description
`request`	`GetBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBackup`	The response to send back to the client (wrapped by a task).

GetBackupPlan(GetBackupPlanRequest, ServerCallContext)

public virtual Task<BackupPlan> GetBackupPlan(GetBackupPlanRequest request, ServerCallContext context)

Gets details of a single BackupPlan.

Parameters
Name	Description
`request`	`GetBackupPlanRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBackupPlan`	The response to send back to the client (wrapped by a task).

GetBackupPlanAssociation(GetBackupPlanAssociationRequest, ServerCallContext)

public virtual Task<BackupPlanAssociation> GetBackupPlanAssociation(GetBackupPlanAssociationRequest request, ServerCallContext context)

Gets details of a single BackupPlanAssociation.

Parameters
Name	Description
`request`	`GetBackupPlanAssociationRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBackupPlanAssociation`	The response to send back to the client (wrapped by a task).

GetBackupVault(GetBackupVaultRequest, ServerCallContext)

public virtual Task<BackupVault> GetBackupVault(GetBackupVaultRequest request, ServerCallContext context)

Gets details of a BackupVault.

Parameters
Name	Description
`request`	`GetBackupVaultRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBackupVault`	The response to send back to the client (wrapped by a task).

GetDataSource(GetDataSourceRequest, ServerCallContext)

public virtual Task<DataSource> GetDataSource(GetDataSourceRequest request, ServerCallContext context)

Gets details of a DataSource.

Parameters
Name	Description
`request`	`GetDataSourceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDataSource`	The response to send back to the client (wrapped by a task).

GetManagementServer(GetManagementServerRequest, ServerCallContext)

public virtual Task<ManagementServer> GetManagementServer(GetManagementServerRequest request, ServerCallContext context)

Gets details of a single ManagementServer.

Parameters
Name	Description
`request`	`GetManagementServerRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskManagementServer`	The response to send back to the client (wrapped by a task).

InitiateBackup(InitiateBackupRequest, ServerCallContext)

public virtual Task<InitiateBackupResponse> InitiateBackup(InitiateBackupRequest request, ServerCallContext context)

Internal only. Initiates a backup.

Parameters
Name	Description
`request`	`InitiateBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskInitiateBackupResponse`	The response to send back to the client (wrapped by a task).

ListBackupPlanAssociations(ListBackupPlanAssociationsRequest, ServerCallContext)

public virtual Task<ListBackupPlanAssociationsResponse> ListBackupPlanAssociations(ListBackupPlanAssociationsRequest request, ServerCallContext context)

Lists BackupPlanAssociations in a given project and location.

Parameters
Name	Description
`request`	`ListBackupPlanAssociationsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBackupPlanAssociationsResponse`	The response to send back to the client (wrapped by a task).

ListBackupPlans(ListBackupPlansRequest, ServerCallContext)

public virtual Task<ListBackupPlansResponse> ListBackupPlans(ListBackupPlansRequest request, ServerCallContext context)

Lists BackupPlans in a given project and location.

Parameters
Name	Description
`request`	`ListBackupPlansRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBackupPlansResponse`	The response to send back to the client (wrapped by a task).

ListBackupVaults(ListBackupVaultsRequest, ServerCallContext)

public virtual Task<ListBackupVaultsResponse> ListBackupVaults(ListBackupVaultsRequest request, ServerCallContext context)

Lists BackupVaults in a given project and location.

Parameters
Name	Description
`request`	`ListBackupVaultsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBackupVaultsResponse`	The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

Lists Backups in a given project and location.

Parameters
Name	Description
`request`	`ListBackupsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBackupsResponse`	The response to send back to the client (wrapped by a task).

ListDataSources(ListDataSourcesRequest, ServerCallContext)

public virtual Task<ListDataSourcesResponse> ListDataSources(ListDataSourcesRequest request, ServerCallContext context)

Lists DataSources in a given project and location.

Parameters
Name	Description
`request`	`ListDataSourcesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDataSourcesResponse`	The response to send back to the client (wrapped by a task).

ListManagementServers(ListManagementServersRequest, ServerCallContext)

public virtual Task<ListManagementServersResponse> ListManagementServers(ListManagementServersRequest request, ServerCallContext context)

Lists ManagementServers in a given project and location.

Parameters
Name	Description
`request`	`ListManagementServersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListManagementServersResponse`	The response to send back to the client (wrapped by a task).

RemoveDataSource(RemoveDataSourceRequest, ServerCallContext)

public virtual Task<Operation> RemoveDataSource(RemoveDataSourceRequest request, ServerCallContext context)

Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.

Parameters
Name	Description
`request`	`RemoveDataSourceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

RestoreBackup(RestoreBackupRequest, ServerCallContext)

public virtual Task<Operation> RestoreBackup(RestoreBackupRequest request, ServerCallContext context)

Restore from a Backup

Parameters
Name	Description
`request`	`RestoreBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

SetInternalStatus(SetInternalStatusRequest, ServerCallContext)

public virtual Task<Operation> SetInternalStatus(SetInternalStatusRequest request, ServerCallContext context)

Sets the internal status of a DataSource.

Parameters
Name	Description
`request`	`SetInternalStatusRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

Returns the caller's permissions on a BackupVault resource.

A caller is not required to have Google IAM permission to make this request.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTestIamPermissionsResponse`	The response to send back to the client (wrapped by a task).

TriggerBackup(TriggerBackupRequest, ServerCallContext)

public virtual Task<Operation> TriggerBackup(TriggerBackupRequest request, ServerCallContext context)

Triggers a new Backup.

Parameters
Name	Description
`request`	`TriggerBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateBackup(UpdateBackupRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackup(UpdateBackupRequest request, ServerCallContext context)

Updates the settings of a Backup.

Parameters
Name	Description
`request`	`UpdateBackupRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateBackupVault(UpdateBackupVaultRequest, ServerCallContext)

public virtual Task<Operation> UpdateBackupVault(UpdateBackupVaultRequest request, ServerCallContext context)

Updates the settings of a BackupVault.

Parameters
Name	Description
`request`	`UpdateBackupVaultRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateDataSource(UpdateDataSourceRequest, ServerCallContext)

public virtual Task<Operation> UpdateDataSource(UpdateDataSourceRequest request, ServerCallContext context)

Updates the settings of a DataSource.

Parameters
Name	Description
`request`	`UpdateDataSourceRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).