com.iland.cohesity.iaas.backups.recovery

Interface FileRecoveryApi

public interface FileRecoveryApi

Exposes operations that relate to file recovery.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
RestoreTask	createFilesAndFoldersDownloadTask(VdcUuid vdcUuid, CreateFilesAndFoldersDownloadTaskParams params) Creates a task for generating a downloadable archive of a set of backup files.
InputStream	downloadBundleFromFilesAndFoldersDownloadTask(VdcUuid vdcUuid, RestoreTaskUid restoreTaskUid) Downloads a ZIP archive that was generated by a bundling task.
InputStream	downloadFile(VdcUuid vdcUuid, DownloadFileParams params) Downloads an individual file from a backup run.
DirectoryListing	getDirectoryListing(VdcUuid vdcUuid, DirectoryListingParams directoryListingParams) Lists files that are present in a specified directory, on a specified VM snapshot.
Stream<FileSnapshotInfo>	getFileSnapshotInfo(VdcUuid vdcUuid, GetFileSnapshotInfoParams params) Retrieves information about all snapshots that exist for a given file, associated with a specified VM and backup group.
Stream<FilesystemVolume>	listVMVolumes(VdcUuid vdcUuid, ListVMVolumesParams params) Lists all volumes present on a specified VM snapshot.
Stream<RecoverableFileSearchResult>	searchRecoverableFilesAndFolders(VdcUuid vdcUuid, SearchRecoverableFilesAndFoldersFilters filters) Searches a vCloud vDC for recoverable files and folders.

Method Detail

searchRecoverableFilesAndFolders

Stream<RecoverableFileSearchResult> searchRecoverableFilesAndFolders(VdcUuid vdcUuid,
                                                                     SearchRecoverableFilesAndFoldersFilters filters)

Searches a vCloud vDC for recoverable files and folders.

Parameters:

vdcUuid - the vDC to search in

filters - search filter params

Returns:

Stream of RecoverableFileSearchResult

getFileSnapshotInfo

Stream<FileSnapshotInfo> getFileSnapshotInfo(VdcUuid vdcUuid,
                                             GetFileSnapshotInfoParams params)

Retrieves information about all snapshots that exist for a given file, associated with a specified VM and backup group.

Parameters:

vdcUuid - the associated vDC

params - GetFileSnapshotInfoParams

Returns:

Stream of FileSnapshotInfo

createFilesAndFoldersDownloadTask

RestoreTask createFilesAndFoldersDownloadTask(VdcUuid vdcUuid,
                                              CreateFilesAndFoldersDownloadTaskParams params)

Creates a task for generating a downloadable archive of a set of backup files. Use downloadBundleFromFilesAndFoldersDownloadTask(VdcUuid, RestoreTaskUid) to download the resulting ZIP archive.

Parameters:

vdcUuid - the associated vDC UUID

params - CreateFilesAndFoldersDownloadTaskParams

Returns:

RestoreTask

Throws:

ValidationException - if params are invalid

downloadFile

InputStream downloadFile(VdcUuid vdcUuid,
                         DownloadFileParams params)

Downloads an individual file from a backup run.

Parameters:

vdcUuid - the associated vDC UUID

params - DownloadFileParams

Returns:

InputStream containing file contents

downloadBundleFromFilesAndFoldersDownloadTask

InputStream downloadBundleFromFilesAndFoldersDownloadTask(VdcUuid vdcUuid,
                                                          RestoreTaskUid restoreTaskUid)

Downloads a ZIP archive that was generated by a bundling task. A bundle can be generated using createFilesAndFoldersDownloadTask(VdcUuid, CreateFilesAndFoldersDownloadTaskParams).

Parameters:

vdcUuid - the UUID of the vDC that is associated with the restore task

restoreTaskUid - RestoreTaskUid

Returns:

InputStream

listVMVolumes

Stream<FilesystemVolume> listVMVolumes(VdcUuid vdcUuid,
                                       ListVMVolumesParams params)

Lists all volumes present on a specified VM snapshot.

Parameters:

vdcUuid - the UUID of the vDC that the snapshot resides in

params - ListVMVolumesParams

Returns:

Stream of FilesystemVolume

getDirectoryListing

DirectoryListing getDirectoryListing(VdcUuid vdcUuid,
                                     DirectoryListingParams directoryListingParams)

Lists files that are present in a specified directory, on a specified VM snapshot.

Parameters:

vdcUuid - the UUID of the vDC that the snapshot is associated with

directoryListingParams - DirectoryListingParams

Returns:

DirectoryListing