Class: Service

Service(connection, serviceId)

A Secondary Web Service.

Constructor

new Service(connection, serviceId)

Creates an object representing a secondary web service stored at the back-end.
Parameters:
Name Type Description
connection Connection A Connection object representing an established connection to an openEO back-end.
serviceId string The service ID.
Source:

Extends

Methods

(async) deleteService()

Deletes the secondary web service from the back-end.
Source:
Throws:
Error

(async) describeService() → {Service}

Updates the data stored in this object by requesting the secondary web service metadata from the back-end.
Source:
Throws:
Error
Returns:
The updates service object (this).
Type
Service

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

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

(async) updateService(parameters) → {Service}

Modifies the secondary web service 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
processGraph object A new process graph.
title string A new title.
description string A new description.
enabled boolean Enables (`true`) or disables (`false`) the service.
parameters object A new set of parameters to set for the service.
plan string A new plan.
budget number A new budget.
Source:
Throws:
Error
Returns:
The updated service object (this).
Type
Service