com.emc.vipr.client.core

Class Workflows

java.lang.Object

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

com.emc.vipr.client.core.AbstractCoreResources<WorkflowRestRep>

com.emc.vipr.client.core.Workflows

All Implemented Interfaces:

Resources<WorkflowRestRep>

public class Workflows
extends AbstractCoreResources<WorkflowRestRep>

Workflows resources.

Base URL: /vdc/workflows

Constructor Summary

Constructors

Constructor and Description
Workflows(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
java.util.List<WorkflowRestRep>	getActive() Gets the list of active workflows.
java.util.List<WorkflowRestRep>	getAll() Gets the list of all workflows.
java.util.List<WorkflowRestRep>	getCompleted() Gets the list of completed workflows.
java.util.List<WorkflowRestRep>	getRecent() Gets the list of recent workflows.
WorkflowStepRestRep	getStep(java.net.URI id) Gets a single workflow step by ID.
java.util.List<WorkflowStepRestRep>	getSteps(java.net.URI id) Gets the list of steps for the given workflow by ID.
Workflows	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Workflows	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Workflows

public Workflows(ViPRCoreClient parent,
                 RestClient client)

Method Detail

withInactive

public Workflows withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<WorkflowRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Workflows withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<WorkflowRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

getAll

public java.util.List<WorkflowRestRep> getAll()

Gets the list of all workflows.

API Call: GET /vdc/workflows

Returns:

the list of recent workflows.

getActive

public java.util.List<WorkflowRestRep> getActive()

Gets the list of active workflows.

API Call: GET /vdc/workflows/active

Returns:

the list of active workflows.

getCompleted

public java.util.List<WorkflowRestRep> getCompleted()

Gets the list of completed workflows.

API Call: GET /vdc/workflows/completed

Returns:

the list of completed workflows.

getRecent

public java.util.List<WorkflowRestRep> getRecent()

Gets the list of recent workflows.

API Call: GET /vdc/workflows/recent

Returns:

the list of recent workflows.

getSteps

public java.util.List<WorkflowStepRestRep> getSteps(java.net.URI id)

Gets the list of steps for the given workflow by ID.

API Call: GET /vdc/workflows/{id}/steps

Parameters:

id - the ID of the workflow.

Returns:

the list of workflow steps.

getStep

public WorkflowStepRestRep getStep(java.net.URI id)

Gets a single workflow step by ID.

API Call: GET /vdc/workflows/steps/{id}

Parameters:

id - the ID of the workflow step.

Returns:

the workflow step.