UdfRuntime: A constructor for UdfRuntime class

In flahn/openeo-r-backend: A back-end implementation for openEO with a local filesystem

Description

A S3 class to store all relevant information about a udf runtime environment for visualization purposes to a user (used at /udf_runtimes endpoint)

Usage

UdfRuntime(id, description = NULL, language, version = NULL,
  libraries = NULL, docker = NULL, tag = NULL, links = NULL,
  performTransaction)

Arguments

id	the id at which the udf runtime will be referencable at openeo.server$udf_runtimes
description	a textual description about the udf runtime environment
language	the underlying programming language to execute the udf script in
version	the version of the programming langunge
libraries	a list of installed libraries of the programming language
docker	the docker image name (either on dockerhub or on a private repository)
tag	the tag of the docker image
links	a link to point to additional information
performTransaction	a function that handles the interaction between back-end and UDF runtime

Details

The performTransaction function is very important! It handles how the UDF is externalized, run and reimported. The UDF processes need to take care of building a UDF transaction object which will work as the link to the calling job or service. The 'performTransaction' then needs to state how to interact with the UDF runtime (hence perform transaction). The function is required to look like this:

function(collection, udf_transaction, importDimensionality,dimensionalityModifier) ...

collection = the collection that comes into the transaction udf_transaction = the UdfTransaction object importDimensionality = (optional) Dimensionality that is used when importing a collection dimensionalityModifier = DimensionalityModifier that is applied on collection to describe the change

The importDimensionality is currently a legacy artifact from the R2Generic implementation.

Value

UdfRuntime class

flahn/openeo-r-backend documentation built on May 6, 2019, 8:50 a.m.