import {WorkflowList} from '@fnndsc/chrisapi'

public class | source

WorkflowList

Extends:

Resource → ListResource → WorkflowList

Workflow list resource object representing a list of pipeline-specific workflows.

Constructor Summary

Public Constructor
public	constructor(url: string, auth: Object) Constructor

Member Summary

Public Members
public	itemClass: Object

Method Summary

Public Methods
public	getPipeline(timeout: number): Promise<Pipeline> Fetch the pipeline associated to this workflow list from the REST API.
public	post(data: Object, timeout: number): Promise<this> Make a POST request to this workflow list resource to create a new workflow item resource through the REST API.

Inherited Summary

From class Resource
public static	cloneObj(obj: Object): * Helper method to make a deep copy clone of the passed object resource.
public get	isEmpty: boolean Return true if the resource object contains any data.
public	auth: Object
public	collection: Object
public	contentType: string
public	url: string
public	clone(): Resource Make a deep copy clone of this object resource.

From class ListResource
public get	data: Object[] Get the list of item data objects (REST API descriptors).
public get	hasNextPage: boolean Return true if the list resource object has a next list page in the paginated REST API.
public get	hasPreviousPage: boolean Return true if the list resource object has a previous list page in the paginated REST API.
public get	totalCount: number Get the total count of items of the entire collection across pages in the paginated REST API.
public	collection: *
public	itemClass: Object
public	queryUrl: string
public	searchParams: Object
public	get(searchParams: Object, timeout: number): Promise<this> Fetch this list resource from the REST API based on search parameters.
public	getItem(id: number): Object Get an item resource object given its id from the list of items in this list resource object.
public	getItems(): Object[] Get an array of item resource objects corresponding to the items in this list resource object.
public	getPOSTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in POST requests.
public	getSearchParameters(): string[] Get an array of search parameter names that can be used as properties of the `searchParams` argument to the `get` method.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass> Internal method to fetch a related resource from the REST API that is referenced by a link relation within this list resource's collection object.
private	_post(data: Object, uploadFileObj: Object, timeout: number): Promise<this> Internal helper method to make a POST request to this list resource through the REST API.

Public Constructors

public constructor(url: string, auth: Object) source

Constructor

Override:

ListResource#constructor

Params:

Name	Type	Attribute	Description
url	string		url of the resource
auth	Object		authentication object
auth.token	string		authentication token

Public Members

public itemClass: Object source

Override:

ListResource#itemClass

Public Methods

public getPipeline(timeout: number): Promise<Pipeline> source

Fetch the pipeline associated to this workflow list from the REST API.

Params:

Name	Type	Attribute	Description
timeout	number	optional default: 30000	request timeout

Return:

Promise<Pipeline>

JS Promise, resolves to a Pipeline object

public post(data: Object, timeout: number): Promise<this> source

Make a POST request to this workflow list resource to create a new workflow item resource through the REST API.

Params:

Name	Type	Attribute	Description
data	Object		request JSON data object
data.previous_plugin_inst_id	number		previous plugin instance id
data.title	string	optional	workflow's title
data.nodes_info	string	optional	pipeline-specific JSON string encoding a list of dictionaries. Each dictionary is a workflow node containing a `plugin piping_id`, `compute_resource_name`, `title` and a list of dictionaries called `plugin_parameter_defaults`. Each dictionary in this list has `name` and `default` keys.
timeout	number	optional default: 30000	request timeout

Return:

Promise<this>

JS Promise, resolves to this object