Package io.nflow.rest.v1

Enum Class ApiWorkflowInstanceInclude

java.lang.Object

java.lang.Enum<ApiWorkflowInstanceInclude>

io.nflow.rest.v1.ApiWorkflowInstanceInclude

All Implemented Interfaces:

Serializable, Comparable<ApiWorkflowInstanceInclude>, Constable

public enum ApiWorkflowInstanceInclude
extends Enum<ApiWorkflowInstanceInclude>

The properties that can be loaded if needed when fetching worklfow instances from the nFlow REST API.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
actions	WorkflowInstanceInclude.ACTIONS
actionStateVariables	WorkflowInstanceInclude.ACTION_STATE_VARIABLES
childWorkflows	WorkflowInstanceInclude.CHILD_WORKFLOW_IDS
currentStateVariables	WorkflowInstanceInclude.CURRENT_STATE_VARIABLES

Method Summary

Modifier and Type	Method	Description
WorkflowInstanceInclude	getInclude()	Provide mapping to WorkflowInstanceInclude.
static ApiWorkflowInstanceInclude	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiWorkflowInstanceInclude[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

currentStateVariables

public static final ApiWorkflowInstanceInclude currentStateVariables

WorkflowInstanceInclude.CURRENT_STATE_VARIABLES

childWorkflows

public static final ApiWorkflowInstanceInclude childWorkflows

WorkflowInstanceInclude.CHILD_WORKFLOW_IDS

actions

public static final ApiWorkflowInstanceInclude actions

WorkflowInstanceInclude.ACTIONS

actionStateVariables

public static final ApiWorkflowInstanceInclude actionStateVariables

WorkflowInstanceInclude.ACTION_STATE_VARIABLES

Method Details

values

public static ApiWorkflowInstanceInclude[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ApiWorkflowInstanceInclude valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getInclude

public WorkflowInstanceInclude getInclude()

Provide mapping to WorkflowInstanceInclude.

Returns:

Corresponding WorkflowInstanceInclude value.