Sentinel Hub · Schema

ZarrOutput

Specifies Zarr creation parameters. If this parameter is specified, all outputs in processRequest **must** be of the type zarr/array and `output` can not be specified. With Zarr output **only** WGS84 and LAEA grids **are supported**.

Satellite ImageryGeospatialRemote SensingEarth ObservationNDVISentinelLandsatMODISOGCSTAC

Properties

Name Type Description
type string
delivery object Path or path template specifying where batch processing results shall be stored. Supported formats:
  • a valid Amazon S3 URL, e.g. `s3://some-bucket/some/folder`.
    The output Zarr will be st
group object
arrayParameters object Parameters that will be used for all output arrays, except where overridden with `arrayOverrides`. Required unless `arrayOverrides` includes all required fields for all output arrays. All fields are s
arrayOverrides object
View JSON Schema on GitHub

JSON Schema

BatchV2ZarrOutput.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.sentinel-hub.com/schemas/BatchV2ZarrOutput",
  "title": "ZarrOutput",
  "description": "Specifies Zarr creation parameters.\n\nIf this parameter is specified, all outputs in processRequest **must**\nbe of the type zarr/array and `output` can not be specified.\nWith Zarr output **only** WGS84 and LAEA grids **are supported**.\n",
  "required": [
    "delivery",
    "group",
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "zarr"
      ]
    },
    "delivery": {
      "description": "Path or path template specifying where batch processing results shall be stored. Supported formats: <ul>\n  <li>a valid Amazon S3 URL, e.g. `s3://some-bucket/some/folder`.<br/>\n    The output Zarr will be stored to this folder (prefix).\n    The request will fail if any files already exist in the folder.\n  </li>\n  <li>a templated Amazon S3 URL, e.g. `s3://some-bucket/some/folder/<requestId>`.\n    The placeholder `<requestId>` will be replaced by the ID of your batch request\n    and the output Zarr will be stored there.\n  </li>\n</ul> The specified path <b>must</b> not contain any subfolders or Zarr files such as <code>.zattrs</code>, <code>.zgroup</code>, <code>.zmetadata</code>.\n",
      "$ref": "#/components/schemas/ObjectStorageInfoV2"
    },
    "group": {
      "$ref": "#/components/schemas/BatchV2ZarrOutputGroup"
    },
    "arrayParameters": {
      "description": "Parameters that will be used for all output arrays, except where overridden with `arrayOverrides`. Required unless `arrayOverrides` includes all required fields for all output arrays. All fields are standard Zarr fields. Further information can be found on the link below.\n",
      "externalDocs": {
        "description": "Zarr metadata specification version 2, Attributes",
        "url": "https://zarr-specs.readthedocs.io/en/latest/v2/v2.0.html#metadata"
      },
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchV2ZarrOutputArrayParameters"
        }
      ]
    },
    "arrayOverrides": {
      "$ref": "#/components/schemas/BatchV2ZarrOutputArrayOverrides"
    }
  }
}