Method: projects.algorithms.list

Gets the list of all the algorithms available for use in Expressions.

HTTP request

GET https://earthengine.googleapis.com/v1alpha/{parent=projects/*}/algorithms

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. 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 parent:

  • earthengine.computations.create

Request body

The request body must be empty.

Response body

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

All the algorithms available for use in Expressions.

JSON representation
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Fields
algorithms[]

object (Algorithm)

A list of the available algorithms.

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 Authentication Overview.

Algorithm

The description of an algorithm available for Expressions.

JSON representation
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
Fields
name

string

The name of the algorithm, in the form "algorithms/...".

description

string

A human-readable description of the algorithm.

returnType

string

The name of the type the algorithm returns.

arguments[]

object (AlgorithmArgument)

Descriptions of the arguments the algorithm takes.

deprecated

boolean

Whether the algorithm is deprecated.

deprecationReason

string

If this algorithm is deprecated, the reason for the deprecation.

hidden

boolean

Whether this algorithm should be hidden in client applications and not shown by default.

preview

boolean

Whether this algorithm is a preview feature and not yet widely available for a general audience.

sourceCodeUri

string

URI of a resource containing the source code of the algorithm. Empty if the user does not have permission or a specific URI could not be determined.

AlgorithmArgument

The description of an argument to an algorithm.

JSON representation
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Fields
argumentName

string

The name of the argument.

type

string

The name of the type of the argument.

description

string

A human-readable description of the argument.

optional

boolean

Whether the argument is optional.

defaultValue

value (Value format)

The default value the argument takes if a value is not provided.