Method: projects.algorithms.list

Recebe a lista de todos os algoritmos disponíveis para uso em expressões.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O ID ou número do projeto do Google Cloud Platform que será tratado como o consumidor de serviço para essa solicitação. O formato é projects/{project-id}.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • earthengine.computations.create

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Todos os algoritmos disponíveis para uso em expressões.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Campos
algorithms[]

object (Algorithm)

Uma lista dos algoritmos disponíveis.

Escopos de autorização

Requer um dos seguintes escopos do 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 mais informações, consulte OAuth 2.0 Overview.

Algoritmo

A descrição de um algoritmo disponível para expressões.

Representação JSON 
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
Campos
name

string

O nome do algoritmo, no formato "algorithms/…".
description

string

Uma descrição legível por humanos do algoritmo.
returnType

string

O nome do tipo retornado pelo algoritmo.
arguments[]

object (AlgorithmArgument)

Descrições dos argumentos que o algoritmo recebe.
deprecated

boolean

Se o algoritmo foi descontinuado.
deprecationReason

string

Se esse algoritmo foi descontinuado, o motivo da descontinuação.
hidden

boolean

Define se esse algoritmo precisa ser oculto em aplicativos cliente e não mostrado por padrão.
preview

boolean

Se esse algoritmo é um recurso de visualização e ainda não está disponível para o público em geral.
sourceCodeUri

string

URI de um recurso que contém o código-fonte do algoritmo. Vazia se o usuário não tiver permissão ou se não for possível determinar um URI específico.

AlgorithmArgument

A descrição de um argumento para um algoritmo.

Representação JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Campos
argumentName

string

O nome do argumento.
type

string

O nome do tipo do argumento.
description

string

Uma descrição legível por humanos do argumento.
optional

boolean

Indica se o argumento é opcional.
defaultValue

value (Value format)

O valor padrão que o argumento assume se um valor não for fornecido.