OperationMetadata

  • Operation metadata describes the state and details of a long-running operation.

  • The metadata includes information such as the operation's state, type, priority, and timestamps for creation, update, start, and end.

  • Progress of the operation is indicated by a numerical value between 0 and 1 and can also be detailed by discrete stages.

  • The metadata can include the originating script URI, destination URIs for output resources, and notifications regarding the operation.

  • Batch EECU usage for the operation is tracked and reported for monitoring and billing purposes.

Metadata describing a long running operation.

JSON representation 
{
  "state": enum (State),
  "description": string,
  "type": string,
  "priority": integer,
  "createTime": string,
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "progress": number,
  "stages": [
    {
      object (OperationStage)
    }
  ],
  "attempt": integer,
  "scriptUri": string,
  "destinationUris": [
    string
  ],
  "notifications": [
    {
      object (OperationNotification)
    }
  ],
  "batchEecuUsageSeconds": number
}
Fields
state

enum (State)

State of the operation.
description

string

Description of the operation.
type

string

The type of this task (e.g., EXPORT_IMAGE, EXPORT_FEATURES, etc.).
priority

integer

Priority of the operation. A higher value indicates a higher priority. The default priority is 100.
createTime

string (Timestamp format)

Time the operation was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Time the operation was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Time the operation started, if the operation has started.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Time the operation ended, if the operation has ended.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
progress

number

Operation progress, in [0, 1] interval.
stages[]

object (OperationStage)

Progress information of the discrete stages for the given operation. Stages, if present, are only for the most recent attempt. If an operation is retried the previous stage information is lost.
attempt

integer

Current attempt number. If an operation is retried the attempt number will increase which can happen in the following situations: - If an operation failed due to the memory limit (likely will cause all following attempts to fail and be permanent), - If resources had to be reallocated for other jobs. (likely to be transient)
scriptUri

string

The URI of the script from which this operation originated, if the operation was started in the Code Editor.
destinationUris[]

string

The URI(s) pointing to the resources output by this operation.
notifications[]

object (OperationNotification)

The notifications for this operation.
batchEecuUsageSeconds

number

The amount of batch EECU-seconds (Earth Engine Compute Units) that this task has used in its most recent execution attempt.

In the case that the task is running, cancelled or failed this number represents the most recent measurement for the in-progress compute usage. This in-progress compute usage is reported to Cloud Monitoring as "In-progress EECU-seconds".

If the task is in the SUCCEEDED state, this number represents the final compute usage. This is the same number that's reported as "Completed EECU-seconds" to Cloud Monitoring. For projects registered for commercial use, this number is also reported as a compute cost in Cloud Billing.

OperationStage

Discerete stage information.

JSON representation 
{
  "displayName": string,
  "completeWorkUnits": number,
  "totalWorkUnits": string,
  "description": string
}
Fields
displayName

string

Name of the stage of the operation.
completeWorkUnits

number

Work currently completed by this stage. Values may be [0, N] where N is equal to totalWorkUnits.
totalWorkUnits

string (int64 format)

Total work to be done by this stage.
description

string

Description details of the stage.

OperationNotification

Notifications are supplementary info pertaining to an operation.

JSON representation 
{
  "severity": enum (Severity),
  "topic": string,
  "detail": string
}
Fields
severity

enum (Severity)

Notification severity.
topic

string

Notification topic (e.g. "task blocked" or "task throttled").
detail

string

Message that should be shown to the user.