Share via

BackupDescription Class

  • Reference
Package:
microsoft.servicefabric.data
  • java.lang.Object
    • microsoft.servicefabric.data.BackupDescription

public class BackupDescription

A BackupDescription contains all of the information necessary to backup a stateful service replica.

Constructor Summary

Constructor Description
BackupDescription(BackupOption backupOption, BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback)

Initializes a new instance of the BackupDescription structure.
BackupDescription(BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback)

Initializes a new instance of the BackupDescription structure.

Method Summary

Modifier and Type Method and Description
BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> getBackupCallback()

Gets the callback to be called when the backup folder has been created locally and is ready to be moved out of the node.

Remarks:Boolean returned by the backupCallback indicate whether the service was able to successfully move the backup folder to an external location. If false is returned, BackupAsync throws InvalidOperationException with the relevant message indicating backupCallback returned false. Also, backup will be marked as unsuccessful.

BackupOption getBackupOption()

The type of backup to perform.

Constructor Details

BackupDescription

public BackupDescription(BackupOption backupOption, BiFunction> backupCallback)

Initializes a new instance of the BackupDescription structure.

Parameters:

backupOption - The backup option for the callback.
backupCallback - Callback to be called when the backup folder has been created and populated locally by the system. This folder is now ready to be moved out of the node.

BackupDescription

public BackupDescription(BiFunction> backupCallback)

Initializes a new instance of the BackupDescription structure.

Parameters:

backupCallback - Callback to be called when the backup folder has been created and populated locally by the system. This folder is now ready to be moved out of the node.

Method Details

getBackupCallback

public BiFunction> getBackupCallback()

Gets the callback to be called when the backup folder has been created locally and is ready to be moved out of the node.

Remarks:Boolean returned by the backupCallback indicate whether the service was able to successfully move the backup folder to an external location. If false is returned, BackupAsync throws InvalidOperationException with the relevant message indicating backupCallback returned false. Also, backup will be marked as unsuccessful.

Returns:

Function

getBackupOption

public BackupOption getBackupOption()

The type of backup to perform.

Returns:

Applies to