com.emc.vipr.client

Class Tasks<R>

java.lang.Object

com.emc.vipr.client.Tasks<R>

Type Parameters:

R - Type of the underlying resource running the operation.

public class Tasks<R>
extends java.lang.Object

Representation of multiple asynchronous tasks returned from an operation.

Constructor Summary

Constructors

Constructor and Description
Tasks(RestClient client, java.util.List<TaskResourceRep> tasks, java.lang.Class<? extends R> resourceClass)

Method Summary

Modifier and Type	Method and Description
Task<R>	firstTask() Retrieves the first task in the list.
java.util.List<R>	get() Waits for tasks to complete (go into a pending or error state).
java.util.List<R>	get(long timeoutMillis) Waits for tasks to complete (go into a pending or error state).
java.util.List<Task<R>>	getTasks() Retrieves all tasks associated with the operation.
Task<R>	latestFinishedTask() Retrieves the latest task in the list that has finished processing.
Tasks<R>	waitFor() Waits for tasks to complete (go into a pending or error state).
Tasks<R>	waitFor(long timeoutMillis) Waits for tasks to complete (go into a pending or error state).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tasks

public Tasks(RestClient client,
             java.util.List<TaskResourceRep> tasks,
             java.lang.Class<? extends R> resourceClass)

Method Detail

getTasks

public java.util.List<Task<R>> getTasks()

Retrieves all tasks associated with the operation.

Returns:

List of tasks.

firstTask

public Task<R> firstTask()

Retrieves the first task in the list.

Returns:

The first task or null if there are no tasks in the list.

latestFinishedTask

public Task<R> latestFinishedTask()

Retrieves the latest task in the list that has finished processing.

Returns:

The latest task or null if there are no tasks in the list.

waitFor

public Tasks<R> waitFor()
                 throws ViPRException

Waits for tasks to complete (go into a pending or error state). If an error occurs it will be thrown as an exception.

Returns:

This tasks.

Throws:

ViPRException - Thrown if any task is in an error state.

waitFor

public Tasks<R> waitFor(long timeoutMillis)
                 throws ViPRException

Waits for tasks to complete (go into a pending or error state). If an error occurs it will be thrown as an exception.

Parameters:

timeoutMillis - Timeout after a number of milliseconds

Returns:

This tasks.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if any task is in an error state.

get

public java.util.List<R> get()

Waits for tasks to complete (go into a pending or error state). If an error occurs it will be thrown as an exception. If any task was successful this returns the actual object for the underlying resource.

Returns:

List of resource objects.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if any task is in an error state.

get

public java.util.List<R> get(long timeoutMillis)

Waits for tasks to complete (go into a pending or error state). If an error occurs it will be thrown as an exception. If any task was successful this returns the actual object for the underlying resource.

Parameters:

timeoutMillis - Timeout after a number of milliseconds

Returns:

List of resource objects.

Throws:

TimeoutException - Thrown if a timeout occurs.

ViPRException - Thrown if any task is in an error state.