Method: projects.algorithms.list

Obtiene la lista de todos los algoritmos disponibles para usar en Expresiones.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Es obligatorio. El ID o el número de proyecto de Google Cloud Platform que se debe considerar como el consumidor de servicios para esta solicitud. El formato es projects/{project-id}.

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • earthengine.computations.create

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Todos los algoritmos disponibles para usar en Expresiones.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Campos
algorithms[]

object (Algorithm)

Una lista de los algoritmos disponibles.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta OAuth 2.0 Overview.

Algoritmo

Es la descripción de un algoritmo disponible para las expresiones.

Representación JSON 
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
Campos
name

string

Es el nombre del algoritmo, en el formato "algorithms/…".
description

string

Es una descripción legible por humanos del algoritmo.
returnType

string

Es el nombre del tipo que muestra el algoritmo.
arguments[]

object (AlgorithmArgument)

Descripciones de los argumentos que toma el algoritmo
deprecated

boolean

Indica si el algoritmo es obsoleto.
deprecationReason

string

Si este algoritmo está obsoleto, el motivo de la baja
hidden

boolean

Indica si este algoritmo se debe ocultar en las aplicaciones cliente y no mostrarse de forma predeterminada.
preview

boolean

Si este algoritmo es una función de versión preliminar y aún no está disponible para el público en general.
sourceCodeUri

string

Es el URI de un recurso que contiene el código fuente del algoritmo. Es vacío si el usuario no tiene permiso o si no se pudo determinar un URI específico.

AlgorithmArgument

La descripción de un argumento para un algoritmo.

Representación JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Campos
argumentName

string

Es el nombre del argumento.
type

string

Es el nombre del tipo del argumento.
description

string

Es una descripción legible por humanos del argumento.
optional

boolean

Indica si el argumento es opcional.
defaultValue

value (Value format)

Es el valor predeterminado que toma el argumento si no se proporciona uno.