run_udf.json

{
    "id": "run_udf",
    "summary": "Run an UDF",
    "description": "Runs an UDF in one of the supported runtime environments.\n\nThe process can either:\n\n1. load and run a locally stored UDF from a file in the workspace of the authenticated user. The path to the UDF file must be relative to the root directory of the user's workspace, so without the user id in the path.\n2. fetch and run a remotely stored and published UDF by absolute URI, for example from [openEO Hub](https://hub.openeo.org)).\n3. run the source code specified inline as string.\n\nThe loaded UDF 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", "udf", "runtime", "version", "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
        },
        "udf": {
            "description": "Either source code, an absolute URL or a path to an UDF script.",
            "schema": {
                "anyOf": [
                    {
                        "description": "URI to an UDF",
                        "type": "string",
                        "format": "uri"
                    },
                    {
                        "description": "Source code as string",
                        "type": "string"
                    }
                ]
            },
            "required": true
        },
        "runtime": {
            "description": "An UDF runtime identifier available at the back-end.",
            "schema": {
                "type": "string"
            },
            "required": true
        },
        "version": {
            "description": "An UDF runtime version. If set to `null`, the default runtime version specified for each runtime is used.",
            "schema": {
                "type": [
                    "string",
                    "null"
                ],
                "default": null
            }
        },
        "context": {
            "description": "Additional data such as configuration options that should be passed to the UDF.",
            "schema": {
                "type": "object",
                "default": {}
            }
        }
    },
    "exceptions": {
        "InvalidVersion": {
            "message": "The specified UDF runtime version is not supported."
        }
    },
    "returns": {
        "description": "The data processed by the UDF. 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."
                }
            ]
        }
    }
}