OPopen-eo
Data Processing
Batch Jobs

Get an estimate for a batch job

Changed on

Calculates an estimate for a batch job. Back-ends can decide to either calculate the duration, the costs, the size or a combination of them. Back-end providers MAY specify an expiry time for the estimate. Starting to process data afterwards MAY be charged at a higher cost. Costs do often not include download costs. Whether download costs are included or not can be indicated explicitly with the downloads_included flag. The estimate SHOULD be the upper limit of the costs, but back-end are free to use the field according to their terms of service. For some batch jobs it is not (easily) possible to estimate the costs reliably, e.g. if a UDF or ML model is part of the process. In this case, the server SHOULD return a EstimateComplexity error with HTTP status code 500.

get/jobs/{job_id}/estimate

Request

Path parameters

job_idstring required

Per-back-end unique identifier of the batch job, generated by the back-end during creation. MUST match the specified pattern.

Example:a3cca2b2aa1e3b5b

Identifier of the batch job.

Response

The estimated costs with regard to money, processing time and storage capacity. At least one of costs, duration or size MUST be provided.

OR
OR

Example response

{
  "costs": 12.98,
  "duration": "P1Y2M10DT2H30M",
  "size": 157286400,
  "downloads_included": 5,
  "expires": "2020-11-01T00:00:00Z"
}

Changes

  • 8556942e05d1Revision changes
    • info

      added subschema #1 subschema #2 subschema #3 to the response body anyOf list for the response status

  • a96fd199026dRevision changes
    • warning

      changed the pattern of the path request parameter job_id from ^[A-Za-z0-9_\-\.~]+$ to ^[\w\-\.~]+$