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 Attributes Description
collections Array.<Collection>
links Array.<Link>
"federation:missing" Array.<string> <optional>

A list of backends from the federation that are missing in the response data.
Source:

FederationBackend

An array of backends in the federation.

Type:
  • object
Properties:
Name Type Description
url string

URL to the versioned API endpoint of the back-end.
title string

Name of the back-end.
description string

A description of the back-end and its specifics.
status string

Current status of the back-ends (online or offline).
last_status_check string

The time at which the status of the back-end was checked last, formatted as a RFC 3339 date-time.
last_successful_check string

If the status is offline: The time at which the back-end was checked and available the last time. Otherwise, this is equal to the property last_status_check. Formatted as a RFC 3339 date-time.
experimental boolean

Declares the back-end to be experimental.
deprecated boolean

Declares the back-end to be deprecated.
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:

Item

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

ItemCollection

Type:
  • object
Properties:
Name Type Attributes Description
features Array.<Item>

The items in the collection.
links Array.<Link> <nullable>

Additional links, e.g. for pagination.
timeStamp string <nullable>

This property indicates the time and date when the response was generated.
numberMatched number <nullable>

The number (integer) of features of the feature type that match the selection parameters.
numberReturned number <nullable>

The number (integer) of features in the feature collection.
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 Attributes Description
href string

The URL to the resource.
rel string <nullable>

Relation type
type string <nullable>

Media type
title string <nullable>

Human-readable title
roles Array.<string> <nullable>

A list of roles, if link is originating from an asset.
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:

OidcClient

Default OpenID Connect Client as returned by the API.

Type:
  • object
Properties:
Name Type Description
id string

Client ID
grant_types Array.<string>

Supported Grant Types
redirect_urls Array.<string>

Allowed Redirect URLs
Source:

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
default_clients Array.<OidcClient>

Default OpenID Connect Clients
links Array.<Link>

Links
Source:

Options

Connection options.

Type:
  • object
Properties:
Name Type Description
addNamespaceToProcess boolean

Add a namespace property to processes if set to true. Defaults to false.
Source:

Process

An openEO processing chain.

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

Processes

Type:
  • object
Properties:
Name Type Attributes Description
processes Array.<Process>
links Array.<Link>
namespaces Array.<string> <nullable>

EXPERIMENTAL!
"federation:missing" Array.<string> <optional>

A list of backends from the federation that are missing in the response data.
Source:

ResponseArray

An array, but enriched with additional details from an openEO API response.

Adds two properties: links and federation:missing.

Type:
  • Array.<*>
Properties:
Name Type Attributes Description
links Array.<Link>

A list of related links.
"federation:missing" Array.<string> <optional>

A list of backends from the federation that are missing in the response data.
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.
type string <nullable>

The content media type returned by the back-end.
logs Array.<Log>

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

UdfRuntime

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

UserAccount

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

UserAccountStorage

Type:
  • object
Properties:
Name Type Description
free number

in bytes as integer
quota number

in bytes as integer
Source:

ValidationResult

An array, but enriched with additional details from an openEO API response.

Adds the property federation:backends.

Type:
Properties:
Name Type Attributes Description
"federation:backends" Array.<string> <optional>

The back-ends that support / do not support the process.
Source:

oidcProviderFactoryFunction(providerInfo) → {AuthProvider|null}

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 | null

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:

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: