Method: projects.algorithms.list

Mendapatkan daftar semua algoritma yang tersedia untuk digunakan dalam Ekspresi.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Project ID atau nomor project project Google Cloud Platform yang harus diperlakukan sebagai konsumen layanan untuk permintaan ini. Format adalah projects/{project-id}.

Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:

  • earthengine.computations.create

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Semua algoritma yang tersedia untuk digunakan dalam Ekspresi.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "algorithms": [
    {
      object (Algorithm)
    }
  ]
}
Kolom
algorithms[]

object (Algorithm)

Daftar algoritma yang tersedia.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • 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

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

Algoritma

Deskripsi algoritma yang tersedia untuk Ekspresi.

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

string

Nama algoritma, dalam bentuk "algorithms/...".
description

string

Deskripsi algoritma yang dapat dibaca manusia.
returnType

string

Nama jenis yang ditampilkan algoritma.
arguments[]

object (AlgorithmArgument)

Deskripsi argumen yang digunakan algoritma.
deprecated

boolean

Apakah algoritma tidak digunakan lagi.
deprecationReason

string

Jika algoritma ini tidak digunakan lagi, alasan penghentian penggunaannya.
hidden

boolean

Apakah algoritma ini harus disembunyikan di aplikasi klien dan tidak ditampilkan secara default.
preview

boolean

Apakah algoritma ini adalah fitur pratinjau dan belum tersedia secara luas untuk audiens umum.
sourceCodeUri

string

URI resource yang berisi kode sumber algoritma. Kosong jika pengguna tidak memiliki izin atau URI tertentu tidak dapat ditentukan.

AlgorithmArgument

Deskripsi argumen untuk algoritma.

Representasi JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
Kolom
argumentName

string

Nama argumen.
type

string

Nama jenis argumen.
description

string

Deskripsi argumen yang dapat dibaca manusia.
optional

boolean

Apakah argumen bersifat opsional.
defaultValue

value (Value format)

Nilai default yang diambil argumen jika nilai tidak diberikan.