Method: projects.algorithms.list

एक्सप्रेशन में इस्तेमाल के लिए उपलब्ध सभी एल्गोरिदम की सूची दिखाता है.

एचटीटीपी अनुरोध

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

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. Google Cloud Platform प्रोजेक्ट का प्रोजेक्ट आईडी या प्रोजेक्ट नंबर, जिसे इस अनुरोध के लिए सेवा उपभोक्ता माना जाना चाहिए. फ़ॉर्मैट projects/{project-id} है.

अनुमति पाने के लिए, दिए गए संसाधन parent पर IAM की यह अनुमति ज़रूरी है:

  • 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

"algorithms/..." फ़ॉर्मैट में, एल्गोरिदम का नाम.

description

string

एल्गोरिदम के बारे में ऐसी जानकारी जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है.

returnType

string

एल्गोरिदम से मिलने वाले डेटा टाइप का नाम.

arguments[]

object (AlgorithmArgument)

उन आर्ग्युमेंट के बारे में जानकारी जिन्हें एल्गोरिदम इस्तेमाल करता है.

deprecated

boolean

एल्गोरिदम बंद हो गया है या नहीं.

deprecationReason

string

अगर इस एल्गोरिदम का इस्तेमाल बंद कर दिया गया है, तो बंद किए जाने की वजह.

hidden

boolean

यह तय करना कि इस एल्गोरिदम को क्लाइंट ऐप्लिकेशन में छिपाया जाए या डिफ़ॉल्ट रूप से न दिखाया जाए.

preview

boolean

क्या यह एल्गोरिदम, झलक दिखाने वाली सुविधा है और अभी तक आम दर्शकों के लिए उपलब्ध नहीं है.

sourceCodeUri

string

उस रिसॉर्स का यूआरआई जिसमें एल्गोरिदम का सोर्स कोड शामिल है. अगर उपयोगकर्ता के पास अनुमति नहीं है या कोई खास यूआरआई तय नहीं किया जा सका, तो यह खाली रहेगा.

AlgorithmArgument

किसी एल्गोरिदम के आर्ग्युमेंट के बारे में जानकारी.

JSON के काेड में दिखाना
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
फ़ील्ड
argumentName

string

आर्ग्युमेंट का नाम.

type

string

आर्ग्युमेंट के टाइप का नाम.

description

string

आर्ग्युमेंट के बारे में ऐसी जानकारी जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है.

optional

boolean

आर्ग्युमेंट ज़रूरी है या नहीं.

defaultValue

value (Value format)

अगर कोई वैल्यू नहीं दी जाती है, तो आर्ग्युमेंट की डिफ़ॉल्ट वैल्यू.