Method: projects.algorithms.list

Получает список всех алгоритмов, доступных для использования в выражениях.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Идентификатор или номер проекта Google Cloud Platform, который следует рассматривать как потребителя услуги для этого запроса. Формат: projects/{project-id} .

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • earthengine.computations.create

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Все алгоритмы, доступные для использования в выражениях.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Поля
algorithms[]

object ( Algorithm )

Список доступных алгоритмов.

Области авторизации

Требуется одна из следующих областей 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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Алгоритм

Описание алгоритма, доступного для Выражений.

JSON-представление 
{
  "name": string,
  "description": string,
  "returnType": string,
  "arguments": [
    {
      object (AlgorithmArgument)
    }
  ],
  "deprecated": boolean,
  "deprecationReason": string,
  "hidden": boolean,
  "preview": boolean,
  "sourceCodeUri": string
}
Поля
name

string

Имя алгоритма в форме «алгоритмы/...».

description

string

Удобочитаемое описание алгоритма.

returnType

string

Имя типа, который возвращает алгоритм.

arguments[]

object ( AlgorithmArgument )

Описания аргументов, которые принимает алгоритм.

deprecated

boolean

Является ли алгоритм устаревшим.

deprecationReason

string

Если этот алгоритм устарел, укажите причину его устаревания.

hidden

boolean

Должен ли этот алгоритм быть скрыт в клиентских приложениях и не отображаться по умолчанию.

preview

boolean

Является ли этот алгоритм предварительной функцией и еще не широко доступен для широкой аудитории.

sourceCodeUri

string

URI ресурса, содержащего исходный код алгоритма. Пусто, если у пользователя нет разрешения или не удалось определить конкретный URI.

АлгоритмАргумент

Описание аргумента алгоритма.

JSON-представление 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Поля
argumentName

string

Имя аргумента.

type

string

Имя типа аргумента.

description

string

Удобочитаемое описание аргумента.

optional

boolean

Является ли аргумент необязательным.

defaultValue

value ( Value format)

Значение по умолчанию, которое принимает аргумент, если значение не указано.