Method: projects.algorithms.list

Pobiera listę wszystkich algorytmów dostępnych do użycia w funkcji Expressions.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagany. Identyfikator lub numer projektu Google Cloud Platform, który powinien być traktowany jako konsument usługi w przypadku tej prośby. Format to projects/{project-id}.

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu: parent

  • earthengine.computations.create

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Wszystkie algorytmy dostępne do użycia w wyrażeniach.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Pola
algorithms[]

object (Algorithm)

lista dostępnych algorytmów;

Zakresy autoryzacji

Wymaga jednego z tych zakresów 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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

Algorytm

Opis algorytmu dostępnego dla wyrażeń.

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

string

Nazwa algorytmu w formacie „algorithms/…”.
description

string

Zrozumiały dla człowieka opis algorytmu.
returnType

string

Nazwa typu zwracanego przez algorytm.
arguments[]

object (AlgorithmArgument)

Opis argumentów, które przyjmuje algorytm.
deprecated

boolean

czy algorytm został wycofany.
deprecationReason

string

Jeśli algorytm został wycofany, podaj powód wycofania.
hidden

boolean

Określa, czy ten algorytm powinien być ukryty w aplikacjach klienta i nie wyświetlany domyślnie.
preview

boolean

czy algorytm jest funkcją w wersji próbnej i nie jest jeszcze powszechnie dostępny dla ogółu użytkowników.
sourceCodeUri

string

Identyfikator URI zasobu zawierającego kod źródłowy algorytmu. Pusty, jeśli użytkownik nie ma uprawnień lub nie można określić konkretnego adresu URI.

AlgorithmArgument

Opis argumentu algorytmu.

Zapis JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Pola
argumentName

string

Nazwa argumentu.
type

string

Nazwa typu argumentu.
description

string

Zrozumiały dla człowieka opis argumentu.
optional

boolean

Określa, czy argument jest opcjonalny.
defaultValue

value (Value format)

Wartość domyślna argumentu, jeśli nie zostanie podana żadna wartość.