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, conductorClientConfiguration, objectMapper, payloadStorage, 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)
WorkflowClient(com.sun.jersey.api.client.config.ClientConfig config, ConductorClientConfiguration clientConfiguration, com.sun.jersey.api.client.ClientHandler handler, com.sun.jersey.api.client.filter.ClientFilter... filters)

Method Summary

Modifier and Type	Method and Description
void	deleteWorkflow(java.lang.String workflowId, boolean archiveWorkflow) Removes a workflow from the system
java.util.List<java.lang.String>	getRunningWorkflow(java.lang.String workflowName, java.lang.Integer version) Retrieve all running workflow instances for a given name and version
com.netflix.conductor.common.run.Workflow	getWorkflow(java.lang.String workflowId, boolean includeTasks) Retrieve a workflow by workflow id
java.util.List<com.netflix.conductor.common.run.Workflow>	getWorkflows(java.lang.String name, java.lang.String correlationId, boolean includeClosed, boolean includeTasks) Retrieve all workflows for a given correlation id and name
java.util.List<java.lang.String>	getWorkflowsByTimePeriod(java.lang.String workflowName, int version, java.lang.Long startTime, java.lang.Long endTime) Retrieve all workflow instances for a given workflow name between a specific time period
void	pauseWorkflow(java.lang.String workflowId) Pause a workflow by workflow id
java.lang.String	rerunWorkflow(java.lang.String workflowId, com.netflix.conductor.common.metadata.workflow.RerunWorkflowRequest rerunWorkflowRequest) Reruns the workflow from a specific task
void	resetCallbacksForInProgressTasks(java.lang.String workflowId) Resets the callback times of all IN PROGRESS tasks to 0 for the given workflow
void	restart(java.lang.String workflowId) Deprecated.
void	restart(java.lang.String workflowId, boolean useLatestDefinitions) Restart a completed workflow
void	resumeWorkflow(java.lang.String workflowId) Resume a paused workflow by workflow id
void	retryLastFailedTask(java.lang.String workflowId) Retries the last failed task in a workflow
void	runDecider(java.lang.String workflowId) Starts the decision task for the given workflow instance
com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.WorkflowSummary>	search(java.lang.Integer start, java.lang.Integer size, java.lang.String sort, java.lang.String freeText, java.lang.String query) Paginated search for workflows based on payload
com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.WorkflowSummary>	search(java.lang.String query) Search for workflows based on payload
void	skipTaskFromWorkflow(java.lang.String workflowId, java.lang.String taskReferenceName) Skips a given task from a current RUNNING workflow
java.lang.String	startWorkflow(com.netflix.conductor.common.metadata.workflow.StartWorkflowRequest startWorkflowRequest) Starts a workflow.
void	terminateWorkflow(java.lang.String workflowId, java.lang.String reason) Terminates the execution of the given workflow instance

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

delete, delete, downloadFromExternalStorage, getForEntity, getForEntity, postForEntity, postForEntity, postForEntityWithRequestOnly, postForEntityWithUriVariablesOnly, put, setRootURI, uploadToExternalPayloadStorage

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 - REST Client configuration

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

WorkflowClient

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

Parameters:

config - REST Client configuration

clientConfiguration - Specific properties configured for the client, see ConductorClientConfiguration

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

startWorkflow

public java.lang.String startWorkflow(com.netflix.conductor.common.metadata.workflow.StartWorkflowRequest startWorkflowRequest)

Starts a workflow. If the size of the workflow input payload is bigger than ConductorClientConfiguration.getWorkflowInputPayloadThresholdKB(), it is uploaded to ExternalPayloadStorage, if enabled, else the workflow is rejected.

Parameters:

startWorkflowRequest - the StartWorkflowRequest object to start the workflow

Returns:

the id of the workflow instance that can be used for tracking

Throws:

ConductorClientException - if ExternalPayloadStorage is disabled or if the payload size is greater than ConductorClientConfiguration.getWorkflowInputMaxPayloadThresholdKB()

getWorkflow

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

Retrieve a workflow by workflow id

Parameters:

workflowId - the id of the workflow

includeTasks - specify if the tasks in the workflow need to be returned

Returns:

the requested workflow

getWorkflows

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

Retrieve all workflows for a given correlation id and name

Parameters:

name - the name of the workflow

correlationId - the correlation id

includeClosed - specify if all workflows are to be returned or only running workflows

includeTasks - specify if the tasks in the workflow need to be returned

Returns:

list of workflows for the given correlation id and name

deleteWorkflow

public void deleteWorkflow(java.lang.String workflowId,
                           boolean archiveWorkflow)

Removes a workflow from the system

Parameters:

workflowId - the id of the workflow to be deleted

archiveWorkflow - flag to indicate if the workflow should be archived before deletion

getRunningWorkflow

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

Retrieve all running workflow instances for a given name and version

Parameters:

workflowName - the name of the workflow

version - the version of the wokflow definition. Defaults to 1.

Returns:

the list of running workflow instances

getWorkflowsByTimePeriod

public java.util.List<java.lang.String> getWorkflowsByTimePeriod(java.lang.String workflowName,
                                                                 int version,
                                                                 java.lang.Long startTime,
                                                                 java.lang.Long endTime)

Retrieve all workflow instances for a given workflow name between a specific time period

Parameters:

workflowName - the name of the workflow

version - the version of the workflow definition. Defaults to 1.

startTime - the start time of the period

endTime - the end time of the period

Returns:

returns a list of workflows created during the specified during the time period

runDecider

public void runDecider(java.lang.String workflowId)

Starts the decision task for the given workflow instance

Parameters:

workflowId - the id of the workflow instance

pauseWorkflow

public void pauseWorkflow(java.lang.String workflowId)

Pause a workflow by workflow id

Parameters:

workflowId - the workflow id of the workflow to be paused

resumeWorkflow

public void resumeWorkflow(java.lang.String workflowId)

Resume a paused workflow by workflow id

Parameters:

workflowId - the workflow id of the paused workflow

skipTaskFromWorkflow

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

Skips a given task from a current RUNNING workflow

Parameters:

workflowId - the id of the workflow instance

taskReferenceName - the reference name of the task to be skipped

rerunWorkflow

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

Reruns the workflow from a specific task

Parameters:

workflowId - the id of the workflow

rerunWorkflowRequest - the request containing the task to rerun from

Returns:

the id of the workflow

restart

@Deprecated
public void restart(java.lang.String workflowId)

Deprecated.

This API has been marked as deprecated and will be removed in a future release. Please use restart(String, boolean) instead.

restart

public void restart(java.lang.String workflowId,
                    boolean useLatestDefinitions)

Restart a completed workflow

Parameters:

workflowId - the workflow id of the workflow to be restarted

useLatestDefinitions - if true, use the latest workflow and task definitions when restarting the workflow if false, use the workflow and task definitions embedded in the workflow execution when restarting the workflow

retryLastFailedTask

public void retryLastFailedTask(java.lang.String workflowId)

Retries the last failed task in a workflow

Parameters:

workflowId - the workflow id of the workflow with the failed task

resetCallbacksForInProgressTasks

public void resetCallbacksForInProgressTasks(java.lang.String workflowId)

Resets the callback times of all IN PROGRESS tasks to 0 for the given workflow

Parameters:

workflowId - the id of the workflow

terminateWorkflow

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

Terminates the execution of the given workflow instance

Parameters:

workflowId - the id of the workflow to be terminated

reason - the reason to be logged and displayed

search

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

Search for workflows based on payload

Parameters:

query - the search query

Returns:

the SearchResult containing the WorkflowSummary that match the query

search

public com.netflix.conductor.common.run.SearchResult<com.netflix.conductor.common.run.WorkflowSummary> search(java.lang.Integer start,
                                                                                                              java.lang.Integer size,
                                                                                                              java.lang.String sort,
                                                                                                              java.lang.String freeText,
                                                                                                              java.lang.String query)

Paginated search for workflows based on payload

Parameters:

start - start value of page

size - number of workflows to be returned

sort - sort order

freeText - additional free text query

query - the search query

Returns:

the SearchResult containing the WorkflowSummary that match the query