Method: projects.value.compute

  • The value:compute endpoint computes an arbitrary value based on an expression.

  • Computation may fail if the result is not expressible as a Value or requires excessive resources.

  • It's generally recommended to use other specific Compute* endpoints for results better suited to them, like ComputeFeatures for a set of features.

  • The request requires a project ID and an Expression in the request body, and the response contains the computed result as a Value.

Computes an arbitrary value. This will fail if the result of the Expression is not something that is expressible as a Value, or if its evaluation requires too many resources. While it is possible (and not an error) to compute any type of object here, in general any Expression producing results that are better suited to one of the other Compute* endpoints should use that endpoint instead (e.g., an Expression whose result is a set of features should use ComputeFeatures).

HTTP request

POST https://earthengine.googleapis.com/v1alpha/{project=projects/*}/value:compute

The URL uses gRPC Transcoding syntax.

Path parameters

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.computations.create

Request body

The request body contains data with the following structure:

JSON representation 
{
  "expression": {
    object (Expression)
  },
  "workloadTag": string
}
Fields
expression

object (Expression)

The expression to compute.
workloadTag

string

User supplied tag to track this computation.

Response body

The results of an arbitrary computation.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "result": value
}
Fields
result

value (Value format)

The results of computing the value of the expression.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/earthengine
  • https://www.googleapis.com/auth/earthengine.readonly
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only

For more information, see the OAuth 2.0 Overview.