Method: projects.algorithms.list

표현식에서 사용할 수 있는 모든 알고리즘의 목록을 가져옵니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수입니다. 이 요청의 서비스 소비자로 간주되어야 하는 Google Cloud Platform 프로젝트의 프로젝트 ID 또는 프로젝트 번호입니다. 형식은 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

알고리즘의 소스 코드가 포함된 리소스의 URI입니다. 사용자에게 권한이 없거나 특정 URI를 확인할 수 없는 경우 비어 있습니다.

AlgorithmArgument

알고리즘의 인수에 대한 설명입니다.

JSON 표현
{
  "argumentName": string,
  "type": string,
  "description": string,
  "optional": boolean,
  "defaultValue": value
}
필드
argumentName

string

인수의 이름입니다.

type

string

인수 유형의 이름입니다.

description

string

인간이 읽을 수 있는 인수 설명입니다.

optional

boolean

인수가 선택사항인지 여부입니다.

defaultValue

value (Value format)

값이 제공되지 않은 경우 인수가 취하는 기본값입니다.