Class: DataStreams

DataStreams(networkPropertiesopt)

new DataStreams(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) getDataStreamById(dataStreamFilteropt) → {Promise.<DataStream>}

Get a specific datastream resource by ID
Parameters:
Name Type Attributes Default Description
dataStreamFilter DataStreamFilter <optional>
 new DataStreamFilter( default datastream filter
Source:
Returns:
- The corresponding DataStream
Type
Promise.<DataStream>

(async) searchDataStreams(dataStreamFilteropt, pageSizeopt) → {Promise.<Collection.<DataStream>>}

List or search all datastreams available through this API.
Parameters:
Name Type Attributes Default Description
dataStreamFilter DataStreamFilter <optional>
 new DataStreamFilter() default DataStream filter
pageSize Number <optional>
 10 default page size
Source:
Returns:
- A Collection of DataStream
Type
Promise.<Collection.<DataStream>>