Class: SamplingFeatures

SamplingFeatures(networkPropertiesopt)

new SamplingFeatures(networkPropertiesopt)

Parameters:
Name Type Attributes Default Description
networkProperties Object <optional>
 {}
Properties
Name Type Attributes Default Description
endpointUrl String defines the Http(s) endpoint URL
tls Boolean defines is use Http or Https secure protocol for fetching data
streamProtocol String <optional>
 'ws' the Stream protocol to use: 'ws' pr 'mqtt'
mqttOpts Object <optional>
 {} the Mqtt options if stream protocol is 'mqtt'
Properties
Name Type Description
prefix String the Mqtt prefix value
endpointUrl String the Mqtt specific endpointUrl
Source:

Methods

(async) getSamplingFeatureById(fId, samplingFeatureFilteropt) → {Promise.<SamplingFeature>}

Get a specific feature resource by ID. Note that this will return the description of the feature valid at the current time. To get the description valid for a past (or future) time, use the "history" sub-collection. route: /samplingFeatures/{id}
Parameters:
Name Type Attributes Default Description
fId String The ID of the SamplingFeature resource
samplingFeatureFilter SamplingFeatureFilter <optional>
 new SamplingFeatureFilter() default SamplingFeature filter
Source:
Returns:
- The corresponding SamplingFeatures as JSON
Type
Promise.<SamplingFeature>

(async) searchSamplingFeatures(samplingFeatureFilteropt, pageSizeopt) → {Promise.<Collection.<SamplingFeatures>>}

List or search all sampled and sampling features available through this API. By default, only top level features and collections are listed (i.e. nested members of feature collections are ommitted) unless the "parent" query parameter is set. route: /samplingFeatures
Parameters:
Name Type Attributes Default Description
samplingFeatureFilter SamplingFeatureFilter <optional>
 new SamplingFeatureFilter() default SamplingFeature filter
pageSize Number <optional>
 10 default page size
Source:
Returns:
- A Collection of SamplingFeatures
Type
Promise.<Collection.<SamplingFeatures>>