forked from Open-EO/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run_udf_externally.json
76 lines (76 loc) · 2.9 KB
/
run_udf_externally.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
"id": "run_udf_externally",
"summary": "Run an externally hosted UDF container",
"description": "Runs a compatible UDF container that is either externally hosted by a service provider or running on a local machine of the user. The UDF container must follow the [openEO UDF specification](https://open-eo.github.io/openeo-udf/).\n\nThe referenced UDF service can be executed as callback in several processes such as ``aggregate_temporal()``, ``apply()``, ``apply_dimension()``, ``filter()`` and ``reduce()``. In this case an array is passed instead of a raster data cube. The user must ensure that the data is properly passed as an array so that the UDF can make sense of it.",
"categories": [
"import",
"udf"
],
"parameter_order": ["data", "url", "context"],
"parameters": {
"data": {
"description": "The data to be passed to the UDF as array or raster data cube.",
"schema": {
"anyOf": [
{
"title": "Raster data cube",
"type": "object",
"format": "raster-cube"
},
{
"title": "Array",
"type": "array",
"minItems": 1,
"items": {
"description": "Any data type."
}
}
]
},
"required": true
},
"url": {
"description": "URL to a remote UDF service.",
"schema": {
"type": "string",
"format": "uri"
},
"required": true
},
"context": {
"description": "Additional data such as configuration options that should be passed to the UDF.",
"schema": {
"type": "object",
"default": {}
}
}
},
"returns": {
"description": "The data processed by the UDF service. Returns a raster data cube if a raster data cube was passed for `data`. If an array was passed for `data`, the returned value is defined by the context and is exactly what the UDF returned.",
"schema": {
"anyOf": [
{
"title": "Raster data cube",
"type": "object",
"format": "raster-cube"
},
{
"title": "Any",
"description": "Any data type."
}
]
}
},
"links": [
{
"rel": "about",
"href": "https://open-eo.github.io/openeo-udf/",
"title": "openEO UDF specification"
},
{
"rel": "about",
"href": "https://github.com/Open-EO/openeo-udf",
"title": "openEO UDF repository"
}
]
}