ee.data.startProcessing
Create processing task that exports or pre-renders an image.
Return value is null if a callback is specified.
Returns an object with fields:
- taskId: Submitted task ID (without hyphens).
- name: Full operation name in the format projects/X/operations/Y
- started: will be 'OK'
- note: may have value 'ALREADY_EXISTS' if an identical task with the same unsubmitted ID already exists.
| Usage | Returns |
|---|
ee.data.startProcessing(taskId, params, callback) | ProcessingResponse |
| Argument | Type | Details |
|---|
taskId | String | Unsubmitted ID for the task (obtained from newTaskId). Used to identify duplicated tasks; may be null. The server will create and return a submitted ID. |
params | Object | The object that describes the processing task; only fields that are common for all processing types are documented here. type (string) Either 'EXPORT_IMAGE', 'EXPORT_FEATURES', 'EXPORT_VIDEO' or 'EXPORT_TILES'. json (string) JSON description of the image. |
callback | Function, optional | An optional callback. If not supplied, the call is made synchronously. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-06 UTC.
[null,null,["Last updated 2023-10-06 UTC."],[[["This processing task exports or pre-renders an image and can be initiated using `ee.data.startProcessing`."],["The function returns an object containing task details like ID, name, status, and potential notes, or null if a callback is provided."],["Task parameters include a user-defined or server-generated task ID and a JSON object describing the image and export type."],["An optional callback function can be included for asynchronous execution."]]],["The `ee.data.startProcessing` function initiates a processing task to export or pre-render an image. It accepts a `taskId`, `params` object (specifying task type and JSON description), and an optional `callback`. The function returns a `ProcessingResponse` object with the submitted task ID, operation name, and start status, or `null` if a callback is provided. `taskId` is a user-defined ID, while the server generates the submitted ID, and `params` specify the task type. A note of `ALREADY_EXISTS` may be present.\n"]]