com.emc.vipr.client.core

Class TasksResources

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<TaskResourceRep>

com.emc.vipr.client.core.TasksResources

All Implemented Interfaces:

BulkResources<TaskResourceRep>, Resources<TaskResourceRep>

public class TasksResources
extends AbstractBulkResources<TaskResourceRep>

Tasks resources.

Base URL: /vdc/task

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TasksResources.State

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_TIME_PARAM
static java.lang.Integer	FETCH_ALL
static java.lang.String	MAX_COUNT_PARAM
static java.lang.String	RESOURCE_PARAM
static java.lang.String	START_TIME_PARAM
static java.lang.String	STATE_PARAM
static java.net.URI	SYSTEM_TENANT
static java.lang.String	TENANT_PARAM
static java.net.URI	USER_TENANT

Constructor Summary

Constructors

Constructor and Description
TasksResources(RestClient client)

Method Summary

Modifier and Type	Method and Description
void	delete(java.net.URI taskId) Delete a task
java.util.List<TaskResourceRep>	findByResource(java.net.URI resourceId)
java.util.List<TaskResourceRep>	findByState(java.net.URI tenantId, TasksResources.State state) Returns tasks matching a particular state for the given tenant
java.util.List<TaskResourceRep>	findCreatedSince(java.net.URI tenantId, long startTime, int maxCount) Returns the specified number of tasks that have been created for the given client since startTime
TaskStatsRestRep	getStats()
TaskStatsRestRep	getStatsByTenant(java.net.URI tenantId) Returns task statistics for the given tenant
java.util.List<NamedRelatedResourceRep>	listAll()
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) List ALL tasks for a specific tenant (use SYSTEM_TENANT for System level tasks).
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId, int maxCount) List specified number of tasks for a specific tenant (use SYSTEM_TENANT for System level tasks).
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId, int maxCount, java.lang.Long startTime, java.lang.Long endTime) List all tasks for a specific tenant (use SYSTEM_TENANT for System level tasks) that were started between startTime and endTime Tasks are returned sorted with the most recent task first
void	resume(java.net.URI taskId) Resume a task
void	rollback(java.net.URI taskId) Rollback a task
TasksResources	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
TasksResources	withInternal(boolean internal) Configures the fetch operations to include internal resources.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Field Detail

SYSTEM_TENANT

public static final java.net.URI SYSTEM_TENANT

USER_TENANT

public static final java.net.URI USER_TENANT

FETCH_ALL

public static final java.lang.Integer FETCH_ALL

TENANT_PARAM

public static final java.lang.String TENANT_PARAM

See Also:

Constant Field Values

RESOURCE_PARAM

public static final java.lang.String RESOURCE_PARAM

See Also:

Constant Field Values

MAX_COUNT_PARAM

public static final java.lang.String MAX_COUNT_PARAM

See Also:

Constant Field Values

START_TIME_PARAM

public static final java.lang.String START_TIME_PARAM

See Also:

Constant Field Values

END_TIME_PARAM

public static final java.lang.String END_TIME_PARAM

See Also:

Constant Field Values

STATE_PARAM

public static final java.lang.String STATE_PARAM

See Also:

Constant Field Values

Constructor Detail

TasksResources

public TasksResources(RestClient client)

Method Detail

listAll

public java.util.List<NamedRelatedResourceRep> listAll()

Returns:

All tasks in the users tenant

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

List ALL tasks for a specific tenant (use SYSTEM_TENANT for System level tasks). Tasks are returned sorted with the most recent task first

Parameters:

tenantId - The tenant tasks are required for

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId,
                                                            int maxCount)

List specified number of tasks for a specific tenant (use SYSTEM_TENANT for System level tasks). Tasks are returned sorted with the most recent task first

Parameters:

tenantId - The tenant tasks are required for

maxCount - The maximum number of tasks to return. Use FETCH_ALL for all tasks

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId,
                                                            int maxCount,
                                                            java.lang.Long startTime,
                                                            java.lang.Long endTime)

List all tasks for a specific tenant (use SYSTEM_TENANT for System level tasks) that were started between startTime and endTime Tasks are returned sorted with the most recent task first

Parameters:

tenantId - The tenant tasks are required for

maxCount - Number of tasks to return or FETCH_ALL for all matching tasks

startTime - Time in milliseconds (Null if not required)

endTime - End time in milliseconds (Null if not required)

findByResource

public java.util.List<TaskResourceRep> findByResource(java.net.URI resourceId)

findByState

public java.util.List<TaskResourceRep> findByState(java.net.URI tenantId,
                                                   TasksResources.State state)

Returns tasks matching a particular state for the given tenant

findCreatedSince

public java.util.List<TaskResourceRep> findCreatedSince(java.net.URI tenantId,
                                                        long startTime,
                                                        int maxCount)

Returns the specified number of tasks that have been created for the given client since startTime

Parameters:

tenantId - The tenant (use USER_TENANT for current users tasks, or SYSTEM_TENANT for system level tasks

startTime - Number of milliseconds since Jan 1 (or Date().getTime())

maxCount - Number of tasks to return or FETCH_ALL for all matching tasks

getStats

public TaskStatsRestRep getStats()

delete

public void delete(java.net.URI taskId)

Delete a task

Parameters:

taskId - task to delete

resume

public void resume(java.net.URI taskId)

Resume a task

Parameters:

taskId - task to resume

rollback

public void rollback(java.net.URI taskId)

Rollback a task

Parameters:

taskId - task to rollback

getStatsByTenant

public TaskStatsRestRep getStatsByTenant(java.net.URI tenantId)

Returns task statistics for the given tenant

withInactive

public TasksResources withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<TaskResourceRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public TasksResources withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<TaskResourceRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.