com.iland.cohesity.iaas.backups.recovery

Interface RestoreTaskApi

public interface RestoreTaskApi

Exposes operations that relate to restore tasks.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
Optional<RestoreTask>	getRestoreTask(VdcUuid vdcUuid, RestoreTaskUid restoreTaskUid) Retrieves a restore task by UID.
Stream<RestoreTask>	listRestoreTasks(VdcUuid vdcUuid, ListRestoreTaskFilters filters) Lists restore tasks with optional filters.
default RestoreTask	waitForTask(RestoreTask restoreTask, Duration pollInterval, Duration timeout) Polls for task for completion and returns the completed task when it is finished or cancelled.

Method Detail

getRestoreTask

Optional<RestoreTask> getRestoreTask(VdcUuid vdcUuid,
                                     RestoreTaskUid restoreTaskUid)

Retrieves a restore task by UID.

Parameters:

vdcUuid - VdcUuid

restoreTaskUid - RestoreTaskUid

Returns:

Optional of RestoreTask

listRestoreTasks

Stream<RestoreTask> listRestoreTasks(VdcUuid vdcUuid,
                                     ListRestoreTaskFilters filters)

Lists restore tasks with optional filters.

Running Restore Tasks are always returned. The newest completed Restore Tasks are returned.

Parameters:

vdcUuid - VdcUuid

filters - ListRestoreTaskFilters

Returns:

Stream of RestoreTask

waitForTask

default RestoreTask waitForTask(RestoreTask restoreTask,
                                Duration pollInterval,
                                Duration timeout)
                         throws TimeoutException,
                                InterruptedException

Polls for task for completion and returns the completed task when it is finished or cancelled.

Parameters:

restoreTask - RestoreTask

pollInterval - Duration interval to poll

timeout - Duration timeout period

Returns:

RestoreTask that is either finished or cancelled

Throws:

TimeoutException - if the wait times out

InterruptedException - if the thread is interrupted while waiting