EventResponse

data class EventResponse(val capabilityId: String? = null, val eventConfiguration: String? = null, val eventNotifier: String, val name: String? = null, val observabilityMode: String? = null)

Defines the event properties.

Constructors

Link copied to clipboard
constructor(capabilityId: String? = null, eventConfiguration: String? = null, eventNotifier: String, name: String? = null, observabilityMode: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val capabilityId: String? = null

The path to the type definition of the capability (e.g. DTMI, OPC UA information model node id, etc.), for example dtmi:com:example:Robot:_contents:__prop1;1.

Link copied to clipboard

Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.

Link copied to clipboard

The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset.

Link copied to clipboard
val name: String? = null

The name of the event.

Link copied to clipboard

An indication of how the event should be mapped to OpenTelemetry.