alluxio.master.backup

Interface BackupOps

All Known Subinterfaces:

BackupRole, MetaMaster

All Known Implementing Classes:

AbstractBackupRole, BackupLeaderRole, BackupWorkerRole, DefaultMetaMaster

public interface BackupOps

Interface for backup operations.

Method Summary

Modifier and Type	Method and Description
BackupStatus	backup(BackupPRequest request, StateLockOptions stateLockOptions) Takes a backup.
BackupStatus	getBackupStatus(BackupStatusPRequest statusPRequest) Used to query the status of a backup.

Method Detail

backup

BackupStatus backup(BackupPRequest request,
                    StateLockOptions stateLockOptions)
             throws AlluxioException

Takes a backup. Note: If backup request ask for async execution, it will return after initiating the backup. Status for the in-progress backup will be returned. getBackupStatus(alluxio.grpc.BackupStatusPRequest) should be called for querying the status of the on-going backup. Note: When leader has no standby in an HA cluster, it will reject backup. This could be allowed by passing "AllowLeader" option in the request.

Parameters:

request - the backup request

stateLockOptions - the state lock options during the backup

Returns:

the backup status response

Throws:

AlluxioException - if backup fails

getBackupStatus

BackupStatus getBackupStatus(BackupStatusPRequest statusPRequest)
                      throws AlluxioException

Used to query the status of a backup.

Parameters:

statusPRequest - status request

Returns:

the status of the latest backup

Throws:

AlluxioException - if request fails