Class ViolationEvent

java.lang.Object
software.amazon.awssdk.services.iot.model.ViolationEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ViolationEvent.Builder,ViolationEvent>
@Generated("software.amazon.awssdk:codegen") public final class ViolationEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ViolationEvent.Builder,ViolationEvent>

Information about a Device Defender security profile behavior violation.

See Also:

  • Method Details

    • 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.

    • violationEventType

      public final ViolationEventType violationEventType()

      The type of violation event.

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

      Returns:
      The type of violation event.
      See Also:

    • violationEventTypeAsString

      public final String violationEventTypeAsString()

      The type of violation event.

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

      Returns:
      The type of violation event.
      See Also:

    • verificationState

      public final VerificationState verificationState()

      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:

    • 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:

    • 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.

    • toBuilder

      public ViolationEvent.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ViolationEvent.Builder,ViolationEvent>
      Returns:
      a builder for type T

    • builder

      public static ViolationEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ViolationEvent.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.