Class: UserProcess

UserProcess(connection, id)

A Stored Process Graph.

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

Members

(protected) apiToClientNames :object.<string, string>

Type:
  • object.<string, string>
Overrides:
Source:

(readonly, nullable) categories :Array.<string>

A list of categories.

Type:
  • Array.<string>
Source:

(protected) clientToApiNames :object.<string, string>

Type:
  • object.<string, string>
Overrides:
Source:

(protected) connection :Connection

Type:
Overrides:
Source:

(readonly, nullable) deprecated :boolean

Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions.

Type:
  • boolean
Source:

(readonly, nullable) description :string

Type:
  • string
Source:

(readonly, nullable) examples :Array.<object.<string, *>>

Type:
  • Array.<object.<string, *>>
Source:

(readonly, nullable) exceptions :object.<string, *>

Declares any exceptions (errors) that might occur during execution of this process.

Type:
  • object.<string, *>
Source:

(readonly, nullable) experimental :boolean

Declares the process or parameter to be experimental, which means that it is likely to change or may produce unpredictable behaviour.

Type:
  • boolean
Source:

(protected) extra :object.<string, *>

Additional (non-standardized) properties received from the API.

Type:
  • object.<string, *>
Overrides:
Source:

(readonly) id :string

The identifier of the process.

Type:
  • string
Source:

(protected) lastRefreshTime :number

Type:
  • number
Overrides:
Source:

Links related to this process.

Type:
Source:

(readonly, nullable) parameters :Array.<object.<string, *>>

A list of parameters.

Type:
  • Array.<object.<string, *>>
Source:

(readonly, nullable) processGraph :object.<string, *>

Type:
  • object.<string, *>
Source:

(readonly, nullable) returns :object.<string, *>

Description of the data that is returned by this process.

Type:
  • object.<string, *>
Source:

(readonly, nullable) summary :string

Type:
  • string
Source:

Methods

(protected) _convertToRequest(parameters) → {object.<string, *>}

Converts the object to a valid objects for API requests.

Parameters:
Name Type Description
parameters object.<string, *>
Overrides:
Source:
Returns:
Type
object.<string, *>

(protected) _supports(feature) → {boolean}

Checks whether a features is supported by the API.

Parameters:
Name Type Description
feature string
Overrides:
Source:
See:
Returns:
Type
boolean

(async) deleteUserProcess()

Deletes the stored process graph from the back-end.

Source:
Throws:
Error

(async) describeUserProcess() → {Promise.<UserProcess>}

Updates the data stored in this object by requesting the process graph metadata from the back-end.

Source:
Throws:
Error
Returns:

The updated process graph object (this).

Type
Promise.<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.<string, *>}

Returns all data in the model.

Overrides:
Source:
Returns:
Type
object.<string, *>

getDataAge() → {number}

Returns the age of the data in seconds.

Overrides:
Source:
Returns:

Age of the data in seconds as integer.

Type
number

(async) replaceUserProcess(parameters) → {Promise.<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
Name Type Description
process Process

A new process.

title string

A new title.

description string

A new description.

Source:
Throws:
Error
Returns:

The updated process graph object (this).

Type
Promise.<UserProcess>

setAll(metadata) → {BaseEntity}

Converts the data from an API response into data suitable for our JS client models.

Parameters:
Name Type Description
metadata object.<string, *>

JSON object originating from an API response.

Overrides:
Source:
Returns:

Returns the object itself.

Type
BaseEntity

toJSON() → {object.<string, *>}

Returns a JSON serializable representation of the data that is API compliant.

Overrides:
Source:
Returns:
Type
object.<string, *>