import {Pipeline} from '@fnndsc/chrisstoreapi'

public class | source

Pipeline

Extends:

Resource → ItemResource → Pipeline

Pipeline item resource object representing a pipeline.

Constructor Summary

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

Method Summary

Public Methods
public	delete(timeout: number): Object Make a DELETE request to delete this pipeline resource through the REST API.
public	getDefaultParameters(params: Object, timeout: number): Object Fetch a list of plugin piping default parameter values for the plugin pipings composing the pipeline from the REST API.
public	getPluginPipings(params: Object, timeout: number): Object Fetch a list of plugin pipings associated to this pipeline from the REST API.
public	getPlugins(params: Object, timeout: number): Object Fetch a list of plugins associated to this pipeline from the REST API.
public	put(data: Object, timeout: number): Object Make a PUT request to modify this pipeline resource through the REST API.

Inherited Summary

From class 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(): Object Make a deep copy clone of this object resource.

From class ItemResource
public get	data: Object Get the item's data object (REST API descriptors).
public	collection: *
public	get(timeout: number): Object Fetch this item resource from the REST API.
public	getPUTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in PUT requests.
private	_delete(timeout: number): Object Internal helper method to make a DELETE request to this item resource through the REST API.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Object Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.
private	_put(data: Object, uploadFileObj: Object, timeout: number): Object Internal helper method to make a PUT request to this item resource through the REST API.

Public Constructors

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

Constructor

Override:

ItemResource#constructor

Params:

Name	Type	Attribute	Description
url	string		url of the resource
auth	Object	optional default: null	authentication object
auth.token	string	optional	authentication token

Public Methods

public delete(timeout: number): Object source

Make a DELETE request to delete this pipeline resource through the REST API.

Params:

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

Return:

Object

JS Promise

public getDefaultParameters(params: Object, timeout: number): Object source

Fetch a list of plugin piping default parameter values for the plugin pipings composing the pipeline from the REST API.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters object
params.limit	number	optional	page limit
params.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PipelinePipingDefaultParameterList object

public getPluginPipings(params: Object, timeout: number): Object source

Fetch a list of plugin pipings associated to this pipeline from the REST API.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters object
params.limit	number	optional	page limit
params.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PipelinePluginPipingList object

public getPlugins(params: Object, timeout: number): Object source

Fetch a list of plugins associated to this pipeline from the REST API.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters object
params.limit	number	optional	page limit
params.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PipelinePluginList object

public put(data: Object, timeout: number): Object source

Make a PUT request to modify this pipeline resource through the REST API.

Params:

Name	Type	Attribute	Description
data	Object		request JSON data object
data.name	string	optional	pipeline name
data.authors	string	optional	pipeline authors
data.category	string	optional	pipeline category
data.description	string	optional	pipeline description
data.locked	boolean	optional	pipeline lock status
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to this object