Method: projects.algorithms.list

Liste aller Algorithmen, die in Expressions verwendet werden können.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Die Projekt-ID oder Projektnummer des Google Cloud-Projekts, das für diese Anfrage als Dienstnutzer behandelt werden soll. Format ist projects/{project-id}.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • earthengine.computations.create

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Alle Algorithmen, die in Expressions verwendet werden können.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Felder
algorithms[]

object (Algorithm)

Eine Liste der verfügbaren Algorithmen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Algorithmus

Die Beschreibung eines Algorithmus, der für Ausdrücke verfügbar ist.

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

string

Der Name des Algorithmus im Format „algorithms/…“.
description

string

Eine für Menschen lesbare Beschreibung des Algorithmus.
returnType

string

Der Name des Typs, den der Algorithmus zurückgibt.
arguments[]

object (AlgorithmArgument)

Beschreibungen der Argumente, die der Algorithmus verwendet.
deprecated

boolean

Gibt an, ob der Algorithmus eingestellt wird.
deprecationReason

string

Wenn dieser Algorithmus eingestellt wurde, der Grund für die Einstellung.
hidden

boolean

Ob dieser Algorithmus in Clientanwendungen ausgeblendet und nicht standardmäßig angezeigt werden soll.
preview

boolean

Ob dieser Algorithmus eine Vorschaufunktion ist und noch nicht allgemein verfügbar ist.
sourceCodeUri

string

URI einer Ressource mit dem Quellcode des Algorithmus. Ist leer, wenn der Nutzer keine Berechtigung hat oder ein bestimmter URI nicht ermittelt werden konnte.

AlgorithmArgument

Die Beschreibung eines Arguments für einen Algorithmus.

JSON-Darstellung 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Felder
argumentName

string

Der Name des Arguments.
type

string

Der Name des Typs des Arguments.
description

string

Eine für Menschen lesbare Beschreibung des Arguments.
optional

boolean

Gibt an, ob das Argument optional ist.
defaultValue

value (Value format)

Der Standardwert, der für das Argument verwendet wird, wenn kein Wert angegeben wird.