Constructor
new UserProcess(connection, id)
Creates an object representing a process graph stored at the back-end.
Parameters:
Name | Type | Description |
---|---|---|
connection |
Connection | A Connection object representing an established connection to an openEO back-end. |
id |
string | ID of a stored process graph. |
- Source:
Extends
Methods
(async) deleteUserProcess()
Deletes the stored process graph from the back-end.
- Source:
Throws:
(async) describeUserProcess() → {UserProcess}
Updates the data stored in this object by requesting the process graph metadata from the back-end.
- Source:
Throws:
Returns:
The updated process graph object (this).
- Type
- UserProcess
get(name) → {*}
Get a value from the additional data that is not part of the core model, i.e. from proprietary extensions.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | Name of the property. |
- Overrides:
- Source:
Returns:
The value, which could be of any type.
- Type
- *
getAll() → {object}
Returns all data in the model.
- Overrides:
- Source:
Returns:
- Type
- object
(async) replaceUserProcess(parameters) → {UserProcess}
Modifies the stored process graph at the back-end and afterwards updates this object, too.
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parameters |
object | An object with properties to update, each of them is optional, but at least one of them must be specified. Additional properties can be set if the server supports them. Properties
|
- Source:
Throws:
Returns:
The updated process graph object (this).
- Type
- UserProcess
setAll(metadata) → {this}
Converts the data from an API response into data suitable for our JS client models.
Parameters:
Name | Type | Description |
---|---|---|
metadata |
object | JSON object originating from an API response. |
- Overrides:
- Source:
Returns:
Returns the object itself.
- Type
- this