com.netflix.conductor.client.http

Class WorkflowClient

java.lang.Object

com.netflix.conductor.client.http.ClientBase

com.netflix.conductor.client.http.WorkflowClient

public class WorkflowClient
extends ClientBase

Field Summary

Fields inherited from class com.netflix.conductor.client.http.ClientBase

client, root

Constructor Summary

Constructors

Constructor and Description
WorkflowClient() Creates a default task client
WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config)
WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config, com.sun.jersey.api.client.ClientHandler handler)
WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config, com.sun.jersey.api.client.ClientHandler handler, com.sun.jersey.api.client.filter.ClientFilter... filters)

Method Summary

Modifier and Type	Method and Description
com.netflix.conductor.common.run.Workflow	getExecutionStatus(java.lang.String workflowId, boolean includeTasks)
java.util.List<java.lang.String>	getRunningWorkflow(java.lang.String workflowName, java.lang.Integer version)
com.netflix.conductor.common.run.Workflow	getWorkflow(java.lang.String workflowId, boolean includeTasks)
com.netflix.conductor.common.metadata.workflow.WorkflowDef	getWorkflowDef(java.lang.String name, java.lang.Integer version)
java.util.List<com.netflix.conductor.common.run.Workflow>	getWorkflows(java.lang.String name, java.lang.String correlationId, boolean includeClosed, boolean includeTasks)
void	pauseWorkflow(java.lang.String workflowId)
void	registerWorkflow(com.netflix.conductor.common.metadata.workflow.WorkflowDef def)
java.lang.String	rerunWorkflow(java.lang.String workflowId, com.netflix.conductor.common.metadata.workflow.RerunWorkflowRequest request)
void	restart(java.lang.String workflowId)
void	resumeWorkflow(java.lang.String workflowId)
void	retryLastFailedTask(java.lang.String workflowId)
void	runDecider(java.lang.String workflowName)
com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.WorkflowSummary>	search(java.lang.String query)
void	skipTaskFromWorkflow(java.lang.String workflowId, java.lang.String taskReferenceName)
java.lang.String	startWorkflow(java.lang.String name, java.lang.Integer version, java.lang.String correlationId, java.util.Map<java.lang.String,java.lang.Object> input)
void	terminateWorkflow(java.lang.String workflowId, java.lang.String reason)

Methods inherited from class com.netflix.conductor.client.http.ClientBase

delete, delete, getForEntity, getForEntity, objectMapper, postForEntity, postForEntity, postForEntity, postForEntity1, put, setRootURI

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowClient

public WorkflowClient()

Creates a default task client

WorkflowClient

public WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config)

Parameters:

config - REST Client configuration

WorkflowClient

public WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config,
                      com.sun.jersey.api.client.ClientHandler handler)

Parameters:

config - REST Client configuration

handler - Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

WorkflowClient

public WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config,
                      com.sun.jersey.api.client.ClientHandler handler,
                      com.sun.jersey.api.client.filter.ClientFilter... filters)

Parameters:

config - config REST Client configuration

handler - handler Jersey client handler. Useful when plugging in various http client interaction modules (e.g. ribbon)

filters - Chain of client side filters to be applied per request

Method Detail

registerWorkflow

public void registerWorkflow(com.netflix.conductor.common.metadata.workflow.WorkflowDef def)

getWorkflowDef

public com.netflix.conductor.common.metadata.workflow.WorkflowDef getWorkflowDef(java.lang.String name,
                                                                                 java.lang.Integer version)

startWorkflow

public java.lang.String startWorkflow(java.lang.String name,
                                      java.lang.Integer version,
                                      java.lang.String correlationId,
                                      java.util.Map<java.lang.String,java.lang.Object> input)

getExecutionStatus

public com.netflix.conductor.common.run.Workflow getExecutionStatus(java.lang.String workflowId,
                                                                    boolean includeTasks)

getWorkflow

public com.netflix.conductor.common.run.Workflow getWorkflow(java.lang.String workflowId,
                                                             boolean includeTasks)

getWorkflows

public java.util.List<com.netflix.conductor.common.run.Workflow> getWorkflows(java.lang.String name,
                                                                              java.lang.String correlationId,
                                                                              boolean includeClosed,
                                                                              boolean includeTasks)

getRunningWorkflow

public java.util.List<java.lang.String> getRunningWorkflow(java.lang.String workflowName,
                                                           java.lang.Integer version)

pauseWorkflow

public void pauseWorkflow(java.lang.String workflowId)

resumeWorkflow

public void resumeWorkflow(java.lang.String workflowId)

restart

public void restart(java.lang.String workflowId)

retryLastFailedTask

public void retryLastFailedTask(java.lang.String workflowId)

terminateWorkflow

public void terminateWorkflow(java.lang.String workflowId,
                              java.lang.String reason)

rerunWorkflow

public java.lang.String rerunWorkflow(java.lang.String workflowId,
                                      com.netflix.conductor.common.metadata.workflow.RerunWorkflowRequest request)

skipTaskFromWorkflow

public void skipTaskFromWorkflow(java.lang.String workflowId,
                                 java.lang.String taskReferenceName)

runDecider

public void runDecider(java.lang.String workflowName)

search

public com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.WorkflowSummary> search(java.lang.String query)