Method: projects.algorithms.list

Recupera l'elenco di tutti gli algoritmi disponibili per l'utilizzo in Espressioni.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. L'ID o il numero del progetto della piattaforma Google Cloud che deve essere considerato il consumatore di servizi per questa richiesta. Il formato è projects/{project-id}.

L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata parent:

  • earthengine.computations.create

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Tutti gli algoritmi disponibili per l'utilizzo in Espressioni.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Campi
algorithms[]

object (Algorithm)

Un elenco degli algoritmi disponibili.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • 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

Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.

Algoritmo

La descrizione di un algoritmo disponibile per le espressioni.

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

string

Il nome dell'algoritmo, nel formato "algorithms/…".
description

string

Una descrizione leggibile dell'algoritmo.
returnType

string

Il nome del tipo restituito dall'algoritmo.
arguments[]

object (AlgorithmArgument)

Descrizioni degli argomenti accettati dall'algoritmo.
deprecated

boolean

Indica se l'algoritmo è deprecato.
deprecationReason

string

Se questo algoritmo è deprecato, il motivo della deprecazione.
hidden

boolean

Indica se questo algoritmo deve essere nascosto nelle applicazioni client e non mostrato per impostazione predefinita.
preview

boolean

Indica se questo algoritmo è una funzionalità di anteprima e non è ancora ampiamente disponibile per un pubblico generale.
sourceCodeUri

string

URI di una risorsa contenente il codice sorgente dell'algoritmo. Vuoto se l'utente non dispone dell'autorizzazione o se non è stato possibile determinare un URI specifico.

AlgorithmArgument

La descrizione di un argomento di un algoritmo.

Rappresentazione JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Campi
argumentName

string

Il nome dell'argomento.
type

string

Il nome del tipo dell'argomento.
description

string

Una descrizione leggibile dell'argomento.
optional

boolean

Indica se l'argomento è facoltativo.
defaultValue

value (Value format)

Il valore predefinito assunto dall'argomento se non viene fornito un valore.