Global

Type Definitions

ApiError

An error.

Type:
  • object
Properties:
Name Type Description
id string
code string
message string
links Array.<Link>
Source:

AuthProviderMeta

Authentication Provider details.

Type:
  • object
Properties:
Name Type Attributes Description
id string <nullable>

Provider identifier, may not be used for all authentication methods.
title string

Title for the authentication method.
description string

Description for the authentication method.
Source:

AxiosResponse

Response for a HTTP request.

Type:
  • object
Properties:
Name Type Description
data *
status number
statusText string
headers *
config object.<string, *>
request *
Source:

BillingPlan

Type:
  • object
Properties:
Name Type Description
name string

Name of the billing plan.
description string

A description of the billing plan, may include CommonMark syntax.
paid boolean

true if it is a paid plan, otherwise false.
url string

A URL pointing to a page describing the billing plan.
default boolean

true if it is the default plan of the back-end, otherwise false.
Source:

Collection

Type:
  • object.<string, *>
Source:

Collections

Type:
  • object
Properties:
Name Type Description
collections Array.<Collection>
links Array.<Link>
Source:

FileType

Type:
  • object
Properties:
Name Type Description
title string
description string
gis_data_types Array.<string>
parameters object.<string, *>
links Array.<Link>
Source:

FileTypesAPI

Type:
  • object
Properties:
Name Type Description
input object.<string, FileType>

File types supported to import
output object.<string, FileType>

File types supported to export
Source:

FromNode

Reference to a parameter.

Type:
  • object
Properties:
Name Type Description
from_node string

The node identifier.
Source:

FromParameter

Reference to a parameter.

Type:
  • object
Properties:
Name Type Description
from_parameter string

The name of the parameter.
Source:

JobEstimate

Type:
  • object
Properties:
Name Type Attributes Description
costs number <nullable>
duration string
size number

in bytes as integer
downloads_included number <nullable>

integer
expires string
Source:

A link to another resource.

Type:
  • object
Properties:
Name Type Description
href string

The URL to the resource.
rel string

Relation type
type string

Media type
title string

Human-readable title
Source:

Log

A log entry.

Type:
  • object
Properties:
Name Type Description
id string
code string
level string
message string
data *
path Array.<object.<string, ?string>>
links Array.<Link>
Source:

LogsAPI

Type:
  • object
Properties:
Name Type Description
logs Array.<Log>
links Array.<Link>
Source:

oidcProviderFactoryFunction(providerInfo) → (nullable) {AuthProvider}

This function is meant to create the OIDC providers used for authentication.

The function gets passed a single argument that contains the provider information as provided by the API, e.g. having the properties id, issuer, title etc.

The function must return an instance of AuthProvider or any derived class. May return null if the instance can't be created.

Parameters:
Name Type Description
providerInfo object.<string, *>

The provider information as provided by the API, having the properties id, issuer, title etc.
Source:
Returns:
Type
AuthProvider

OidcProviderMeta

OpenID Connect Provider details as returned by the API.

Type:
  • object
Properties:
Name Type Description
id string

Provider identifier.
title string

Title for the authentication method.
description string

Description for the authentication method.
issuer string

The OpenID Connect issuer location (authority).
scopes Array.<string>

OpenID Connect Scopes
links Array.<Link>

Links
Source:

Process

An openEO processing chain.

Type:
  • object.<string, *>
Source:

Processes

Type:
  • object
Properties:
Name Type Description
processes Array.<Process>
links Array.<Link>
Source:

ServiceType

Type:
  • object.<string, *>
Source:

SyncResult

Type:
  • object
Properties:
Name Type Attributes Description
data Stream.Readable | Blob

The data as Stream in NodeJS environments or as Blob in browsers.
costs number <nullable>

The costs for the request in the currency exposed by the back-end.
logs Array.<Log>

Array of log entries as specified in the API.
Source:

UdfRuntime

Type:
  • object.<string, *>
Source:

uploadStatusCallback(percentCompleted)

A callback that is executed on upload progress updates.

Parameters:
Name Type Description
percentCompleted number

The percent (0-100) completed.
Source:

uploadStatusCallback(percentCompleted, file)

A callback that is executed on upload progress updates.

Parameters:
Name Type Description
percentCompleted number

The percent (0-100) completed.
file UserFile

The file object corresponding to the callback.
Source:

UserAccount

Type:
  • object
Properties:
Name Type Attributes Description
user_id string
name string
storage UserAccountStorage
budget number <nullable>
links Array.<Link>
Source:

UserAccountStorage

Type:
  • object
Properties:
Name Type Description
free number

in bytes as integer
quota number

in bytes as integer
Source: