Disruptive Documentation

Structure Data​Connector

public struct DataConnector: Decodable, Equatable  

A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend to an external service. It can be set up to send specific types of events to a configurable endpoint through an HTTP POST request.

Functions relevant for DataConnectors are implemented on the Disruptive struct:

To learn more about Data Connectors, see the following article on the developer website:

%55 DataConnector DataConnector Decodable Decodable DataConnector->Decodable Equatable Equatable DataConnector->Equatable

Nested Types

DataConnector.Metrics

Represents the metrics such as success-rate and latency for the past 3 hours of a Data Connector.

DataConnector.Status

The current status of a Data Connector. This will indicate whether or not the Data Connector is currently sending out events.

DataConnector.PushType

The mechanism used by a Data Connector to push device events to an external service.

Conforms To

Decodable
Equatable

Initializers

init(from:​)

public init(from decoder: Decoder) throws  

Properties

identifier

public let identifier: String

The unique identifier of the Data Connector. This will be different from thename field in the REST API in that it is just the identifier without the projects/*/dataconnectors/ prefix.

project​ID

public let projectID: String

The identifier of the project the Data Connector is in.

push​Type

public let pushType: PushType

Describes the mechanism for how to push events to an external service, with configurable parameters. See more in the documentation for the type itself.

display​Name

public let displayName: String

The display name of the Data Connector.

status

public let status: Status

The current status of the Data Connector. This will indicate whether or not the Data Connector is currently sending out events.

events

public let events: [EventType] 

The event types that the Data Connector can send.

labels

public let labels: [String] 

The labels that could be included along with an event (if the label is present on the device the event comes from).