Sentinel Hub · Schema

GSBucketInfoTemplated

Satellite ImageryGeospatialRemote SensingEarth ObservationNDVISentinelLandsatMODISOGCSTAC

Properties

Name Type Description
url string A URL or URL template specifying where the results shall be written. Supported formats:
  • a valid Google Cloud Storage URL, e.g. `gs://my-bucket/some-folder`. A subdirectory will be created for
credentials string Base64-encoded service account credentials in JSON format.
View JSON Schema on GitHub

JSON Schema

GSBucketInfoTemplated.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.sentinel-hub.com/schemas/GSBucketInfoTemplated",
  "title": "GSBucketInfoTemplated",
  "type": "object",
  "required": [
    "url",
    "credentials"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "A URL or URL template specifying where the results shall be written. Supported formats: <ul>\n  <li>a valid Google Cloud Storage URL, e.g. `gs://my-bucket/some-folder`.\n    A subdirectory will be created for this statistical batch request, named after the request ID, and output JSON files will be stored there.\n    This is equivalent to the template `gs://my-bucket/some-folder/<REQUEST_ID>/<ID>.json`.\n  </li>\n  <li>a templated Google Cloud Storage URL, e.g. `gs://my-bucket/some-folder/<ID>.json`.\n    Templating allows custom organization of the output files.\n    Templates can contain the following placeholders, which are replaced by respective actual values when writing results:\n    <ul>\n      <li> `<REQUEST_ID>` - the ID of your statistical batch request,</li>\n      <li> `<ID>` - the `id` property of the feature,</li>\n      <li> `<IDENTIFIER>` - the `identifier` property of the feature.</li>\n    </ul>\n    The template must contain `<ID>` or `<IDENTIFIER>` in order to ensure unique output files.\n  </li>\n</ul>\n"
    },
    "credentials": {
      "type": "string",
      "description": "Base64-encoded service account credentials in JSON format."
    }
  }
}