io.nflow.rest.v1.ApiWorkflowInstanceInclude Maven / Gradle / Ivy
The newest version!
package io.nflow.rest.v1;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import io.nflow.engine.service.WorkflowInstanceInclude;
/**
* The properties that can be loaded if needed when fetching worklfow instances from the nFlow REST API.
*/
@SuppressFBWarnings(value = "OPM_OVERLY_PERMISSIVE_METHOD", justification = "valueOf is provided by enum")
public enum ApiWorkflowInstanceInclude {
/**
* {@link WorkflowInstanceInclude#CURRENT_STATE_VARIABLES}
*/
currentStateVariables(WorkflowInstanceInclude.CURRENT_STATE_VARIABLES),
/**
* {@link WorkflowInstanceInclude#CHILD_WORKFLOW_IDS}
*/
childWorkflows(WorkflowInstanceInclude.CHILD_WORKFLOW_IDS),
/**
* {@link WorkflowInstanceInclude#ACTIONS}
*/
actions(WorkflowInstanceInclude.ACTIONS),
/**
* {@link WorkflowInstanceInclude#ACTION_STATE_VARIABLES}
*/
actionStateVariables(WorkflowInstanceInclude.ACTION_STATE_VARIABLES);
private final WorkflowInstanceInclude include;
ApiWorkflowInstanceInclude(WorkflowInstanceInclude include) {
this.include = include;
}
/**
* Provide mapping to {@link WorkflowInstanceInclude}.
*
* @return Corresponding {@link WorkflowInstanceInclude} value.
*/
public WorkflowInstanceInclude getInclude() {
return include;
}
/**
* Resolve enum value from string.
*
* @param value The possible enum value to resolve.
* @return Matching enum value, or null if no match found.
*/
static ApiWorkflowInstanceInclude fromValue(String value) {
try {
return valueOf(value);
} catch (@SuppressWarnings("unused") IllegalArgumentException e) {
return null;
}
}
}