Initiates a batch process that computes an image and writes the result to one of several destinations.
HTTP request
POST https://earthengine.googleapis.com/v1/{project=projects/*}/image:export
The URL uses gRPC Transcoding syntax.
Path parameters
project
string
The project id or project number of the Google Cloud Platform project that should be treated as the service consumer for this request. Format is projects/{project-id}
.
Authorization requires the following IAM
permission on the specified resource project
:
-
earthengine.exports.create
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "expression" : { object ( |
expression
object (
Expression
)
An expression that evaluates to the image to compute and export.
description
string
A human-readable name of the task.
maxPixels
string ( Int64Value
format)
The maximum number of pixels to compute and export. This is a safety guard to prevent you from accidentally starting a larger export than you had intended. The default value is 1e8 pixels, but you can set the value explicitly to raise or lower this limit.
grid
object (
PixelGrid
)
Parameters describing how the image computed by expression
should be reprojected and clipped. If not present, the full computed image is returned in its native projection.
requestId
string
A unique string used to detect duplicated requests. If more than one request is made by the same user with the same non-empty requestId
, only one of those requests may successfully start a long-running operation. requestId
may contain the characters a..z, A..Z, 0-9, or '-'. requestId
may be at most 60 characters long.
workloadTag
string
User supplied label to track this computation.
priority
integer
Optional. The priority of the export task within the project. Higher priority tasks are scheduled sooner. Must be an integer between 0 and 9999. Defaults to 100 if not set.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/earthengine -
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/devstorage.full_control
For more information, see the OAuth 2.0 Overview .
ImageAssetExportOptions
Options for saving images as Earth Engine assets.
| JSON representation |
|---|
{ "pyramidingPolicy" : enum ( |
pyramidingPolicy
enum (
PyramidingPolicy
)
The pyramiding policy to apply by default to all bands.
pyramidingPolicyOverrides
map (key: string, value: enum (
PyramidingPolicy
))
Specific per-band pyramid policy overrides.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
destination
. Where to write the results. destination
can be only one of the following:earthEngineDestination
object (
EarthEngineDestination
)
If specified, configures export to Earth Engine.
