run_udf.json

{
    "id": "run_udf",
    "summary": "Run a UDF",
    "description": "Runs a UDF in one of the supported runtime environments.\n\nThe process can either:\n\n1. load and run a UDF stored in a file on the server-side workspace of the authenticated user. The path to the UDF file must be relative to the root directory of the user's workspace.\n2. fetch and run a remotely stored and published UDF by absolute URI.\n3. run the source code specified inline as string.\n\nThe loaded UDF can be executed in several processes such as ``aggregate_spatial()``, ``apply()``, ``apply_dimension()`` and ``reduce_dimension()``. 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": [
        "cubes",
        "import",
        "udf"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "The data to be passed to the UDF as an array or raster data cube.",
            "schema": [
                {
                    "title": "Raster data cube",
                    "type": "object",
                    "subtype": "raster-cube"
                },
                {
                    "title": "Array",
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "description": "Any data type."
                    }
                },
                {
                    "title": "Single Value",
                    "description": "A single value of any data type."
                }
            ]
        },
        {
            "name": "udf",
            "description": "Either source code, an absolute URL or a path to a UDF script.",
            "schema": [
                {
                    "description": "Absolute URL to a UDF",
                    "type": "string",
                    "format": "uri",
                    "subtype": "uri",
                    "pattern": "^(http|https)://"
                },
                {
                    "description": "Path to a UDF uploaded to the server.",
                    "type": "string",
                    "subtype": "file-path",
                    "pattern": "^[^\r\n\\:'\"]+$"
                },
                {
                    "description": "The multi-line source code of a UDF, must contain a newline/line-break.",
                    "type": "string",
                    "subtype": "udf-code",
                    "pattern": "(\r\n|\r|\n)"
                }
            ]
        },
        {
            "name": "runtime",
            "description": "A UDF runtime identifier available at the back-end.",
            "schema": {
                "type": "string",
                "subtype": "udf-runtime"
            }
        },
        {
            "name": "version",
            "description": "An UDF runtime version. If set to `null`, the default runtime version specified for each runtime is used.",
            "schema": [
                {
                    "type": "string",
                    "subtype": "udf-runtime-version"
                },
                {
                    "title": "Default runtime version",
                    "type": "null"
                }
            ],
            "default": null,
            "optional": true
        },
        {
            "name": "context",
            "description": "Additional data such as configuration options to be passed to the UDF.",
            "schema": {
                "type": "object"
            },
            "default": {},
            "optional": true
        }
    ],
    "exceptions": {
        "InvalidVersion": {
            "message": "The specified UDF runtime version is not supported."
        }
    },
    "returns": {
        "description": "The data processed by the UDF.\n\n* Returns a raster data cube, if a raster data cube is passed for `data`. Details on the dimensions and dimension properties (name, type, labels, reference system and resolution) depend on the UDF.\n* If an array is passed for `data`, the returned value can be of any data type, but is exactly what the UDF returns.",
        "schema": [
            {
                "title": "Raster data cube",
                "type": "object",
                "subtype": "raster-cube"
            },
            {
                "title": "Any",
                "description": "Any data type."
            }
        ]
    }
}