Class: SweApi

SweApi(name, properties)

new SweApi(name, properties)

Parameters:
Name Type Description
name String the datasource name
properties Object the datasource properties
Properties
Name Type Attributes Default Description
protocol String defines the protocol of the datasource. @see DataConnector, 'http', 'ws', 'mqtt', 'file', 'topic'
endpointUrl String the endpoint url, this property is ignored in case of using 'mqtt' protocol, the properties.mqttOpts.endpointUrl will be used instead
resource String the resource, /procedures, /fois, /observations, /tasks, /datastreams/4778/obs
tls Boolean defines if use secure TLS connection
connectorOpts Boolean connector specific Opts
mqttOpts Object <optional>
{} the Mqtt options if protocol is 'mqtt'
Properties
Name Type Description
prefix String the Mqtt prefix value
endpointUrl String the Mqtt specific endpointUrl
responseFormat Number <optional>
application/om+json the response format (e.g application/om+json)
parentId Array.<String> <optional>
the parent id
keywords Array.<String> <optional>
the keyword ids
includedProps Array.<String> <optional>
the included properties
excludedProps Array.<String> <optional>
the excluded properties
roi string <optional>
WKT geometry and operator to filter resources on their location or geometry
featureOfInterest Array.<String> <optional>
Comma separated list of feature of interest IDs to get observations for.
observedProperty Array.<String> <optional>
Comma separated list of observed property URIs to get observations for.
prefetchBatchSize Array.<String> <optional>
250 Number of elements to prefetch at a time
prefetchBatchDuration Array.<String> <optional>
5000 Duration before prefetching the next batch. N.b the next batch will be prefetched at 80% of this duration
Source: