Class Event
java.lang.Object
com.azure.resourcemanager.deviceregistry.models.Event
Defines the event properties.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the capabilityId property: The path to the type definition of the capability (e.g.Get the eventConfiguration property: Protocol-specific configuration for the event.Get the eventNotifier property: The address of the notifier of the event in the asset (e.g.name()
Get the name property: The name of the event.Get the observabilityMode property: An indication of how the event should be mapped to OpenTelemetry.void
validate()
Validates the instance.withCapabilityId
(String capabilityId) Set the capabilityId property: The path to the type definition of the capability (e.g.withEventConfiguration
(String eventConfiguration) Set the eventConfiguration property: Protocol-specific configuration for the event.withEventNotifier
(String eventNotifier) Set the eventNotifier property: The address of the notifier of the event in the asset (e.g.Set the name property: The name of the event.withObservabilityMode
(EventsObservabilityMode observabilityMode) Set the observabilityMode property: An indication of how the event should be mapped to OpenTelemetry.
-
Constructor Details
-
Event
public Event()Creates an instance of Event class.
-
-
Method Details
-
name
Get the name property: The name of the event.- Returns:
- the name value.
-
withName
Set the name property: The name of the event.- Parameters:
name
- the name value to set.- Returns:
- the Event object itself.
-
eventNotifier
Get the eventNotifier property: 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.- Returns:
- the eventNotifier value.
-
withEventNotifier
Set the eventNotifier property: 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.- Parameters:
eventNotifier
- the eventNotifier value to set.- Returns:
- the Event object itself.
-
capabilityId
Get the capabilityId property: 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.- Returns:
- the capabilityId value.
-
withCapabilityId
Set the capabilityId property: 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.- Parameters:
capabilityId
- the capabilityId value to set.- Returns:
- the Event object itself.
-
observabilityMode
Get the observabilityMode property: An indication of how the event should be mapped to OpenTelemetry.- Returns:
- the observabilityMode value.
-
withObservabilityMode
Set the observabilityMode property: An indication of how the event should be mapped to OpenTelemetry.- Parameters:
observabilityMode
- the observabilityMode value to set.- Returns:
- the Event object itself.
-
eventConfiguration
Get the eventConfiguration property: Protocol-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.- Returns:
- the eventConfiguration value.
-
withEventConfiguration
Set the eventConfiguration property: Protocol-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize.- Parameters:
eventConfiguration
- the eventConfiguration value to set.- Returns:
- the Event object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-