workflow-manager
workflow-manager client library.
- workflow-manager
- WorkflowManager ⏏
- new WorkflowManager(options)
- instance
- .healthCheck([options], [cb]) ⇒
Promise
- .getJobsForWorkflow(workflowName, [options], [cb]) ⇒
Promise
- .startJobForWorkflow(input, [options], [cb]) ⇒
Promise
- .CancelJob(params, [options], [cb]) ⇒
Promise
- .GetJob(jobId, [options], [cb]) ⇒
Promise
- .newWorkflow(NewWorkflowRequest, [options], [cb]) ⇒
Promise
- .getWorkflowByName(name, [options], [cb]) ⇒
Promise
- .updateWorkflow(params, [options], [cb]) ⇒
Promise
- static
WorkflowManager ⏏
workflow-manager client
Kind: Exported class
new WorkflowManager(options)
Create a new client object.
Param | Type | Default | Description |
---|
options | Object | | Options for constructing a client object. |
[options.address] | string | | URL where the server is located. Must provide this or the discovery argument |
[options.discovery] | bool | | Use clever-discovery to locate the server. Must provide this or the address argument |
[options.timeout] | number | | The timeout to use for all client requests, in milliseconds. This can be overridden on a per-request basis. |
[options.retryPolicy] | RetryPolicies | RetryPolicies.Single | The logic to determine which requests to retry, as well as how many times to retry. |
workflowManager.healthCheck([options], [cb]) ⇒ Promise
Checks if the service is healthy
Kind: instance method of WorkflowManager
Fulfill: undefined
Reject: BadRequest
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.getJobsForWorkflow(workflowName, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object[]
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
workflowName | string | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.startJobForWorkflow(input, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
input | | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.CancelJob(params, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: undefined
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
params | Object | |
params.jobId | string | |
params.reason | | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.GetJob(jobId, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
jobId | string | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.newWorkflow(NewWorkflowRequest, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object
Reject: BadRequest
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
NewWorkflowRequest | | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.getWorkflowByName(name, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
name | string | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
workflowManager.updateWorkflow(params, [options], [cb]) ⇒ Promise
Kind: instance method of WorkflowManager
Fulfill: Object
Reject: BadRequest
Reject: NotFound
Reject: InternalError
Reject: Error
Param | Type | Description |
---|
params | Object | |
[params.NewWorkflowRequest] | | |
params.name | string | |
[options] | object | |
[options.timeout] | number | A request specific timeout |
[options.span] | Span | An OpenTracing span - For example from the parent request |
[options.retryPolicy] | RetryPolicies | A request specific retryPolicy |
[cb] | function | |
WorkflowManager.RetryPolicies
Retry policies available to use.
Kind: static property of WorkflowManager
RetryPolicies.Exponential
The exponential retry policy will retry five times with an exponential backoff.
Kind: static constant of RetryPolicies
RetryPolicies.Single
Use this retry policy to retry a request once.
Kind: static constant of RetryPolicies
RetryPolicies.None
Use this retry policy to turn off retries.
Kind: static constant of RetryPolicies
WorkflowManager.Errors
Errors returned by methods.
Kind: static property of WorkflowManager
Errors.BadRequest ⇐ Error
BadRequest
Kind: static class of Errors
Extends: Error
Properties
Errors.InternalError ⇐ Error
InternalError
Kind: static class of Errors
Extends: Error
Properties
Errors.NotFound ⇐ Error
NotFound
Kind: static class of Errors
Extends: Error
Properties