Class ViolationEvent

    • Method Detail

      • violationId

        public final String violationId()

        The ID of the violation event.

        Returns:
        The ID of the violation event.
      • thingName

        public final String thingName()

        The name of the thing responsible for the violation event.

        Returns:
        The name of the thing responsible for the violation event.
      • securityProfileName

        public final String securityProfileName()

        The name of the security profile whose behavior was violated.

        Returns:
        The name of the security profile whose behavior was violated.
      • behavior

        public final Behavior behavior()

        The behavior that was violated.

        Returns:
        The behavior that was violated.
      • metricValue

        public final MetricValue metricValue()

        The value of the metric (the measurement).

        Returns:
        The value of the metric (the measurement).
      • violationEventAdditionalInfo

        public final ViolationEventAdditionalInfo violationEventAdditionalInfo()

        The details of a violation event.

        Returns:
        The details of a violation event.
      • verificationStateAsString

        public final String verificationStateAsString()

        The verification state of the violation (detect alarm).

        If the service returns an enum value that is not available in the current SDK version, verificationState will return VerificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStateAsString().

        Returns:
        The verification state of the violation (detect alarm).
        See Also:
        VerificationState
      • verificationStateDescription

        public final String verificationStateDescription()

        The description of the verification state of the violation.

        Returns:
        The description of the verification state of the violation.
      • violationEventTime

        public final Instant violationEventTime()

        The time the violation event occurred.

        Returns:
        The time the violation event occurred.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)