Method: projects.algorithms.list

فهرستی از همه الگوریتم‌های موجود برای استفاده در Expression را دریافت می‌کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

مورد نیاز. شناسه پروژه یا شماره پروژه پروژه Google Cloud Platform که باید به عنوان مصرف کننده سرویس برای این درخواست در نظر گرفته شود. قالب projects/{project-id} است.

مجوز نیاز به مجوز IAM زیر در parent منبع مشخص شده دارد:

  • earthengine.computations.create

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

تمام الگوریتم های موجود برای استفاده در Expressions.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی 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 .

الگوریتم

شرح یک الگوریتم موجود برای Expressions.

نمایندگی 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 خاصی مشخص نشود، خالی است.

Argument الگوریتم

شرح یک آرگومان به یک الگوریتم.

نمایندگی JSON 
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
فیلدها
argumentName

string

نام استدلال.

type

string

نام نوع استدلال.

description

string

شرحی قابل خواندن برای انسان از استدلال.

optional

boolean

اینکه آیا آرگومان اختیاری است.

defaultValue

value ( Value format)

مقدار پیش فرضی که آرگومان می گیرد اگر مقداری ارائه نشود.