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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ViolationEvent.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Behavior
behavior()
The behavior that was violated.static ViolationEvent.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
MetricValue
metricValue()
The value of the metric (the measurement).List<SdkField<?>>
sdkFields()
String
securityProfileName()
The name of the security profile whose behavior was violated.static Class<? extends ViolationEvent.Builder>
serializableBuilderClass()
String
thingName()
The name of the thing responsible for the violation event.ViolationEvent.Builder
toBuilder()
String
toString()
Returns a string representation of this object.VerificationState
verificationState()
The verification state of the violation (detect alarm).String
verificationStateAsString()
The verification state of the violation (detect alarm).String
verificationStateDescription()
The description of the verification state of the violation.ViolationEventAdditionalInfo
violationEventAdditionalInfo()
The details of a violation event.Instant
violationEventTime()
The time the violation event occurred.ViolationEventType
violationEventType()
The type of violation event.String
violationEventTypeAsString()
The type of violation event.String
violationId()
The ID of the violation event.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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.
-
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 returnViolationEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromviolationEventTypeAsString()
.- Returns:
- The type of violation event.
- See Also:
ViolationEventType
-
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 returnViolationEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromviolationEventTypeAsString()
.- Returns:
- The type of violation event.
- See Also:
ViolationEventType
-
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 returnVerificationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStateAsString()
.- Returns:
- The verification state of the violation (detect alarm).
- See Also:
VerificationState
-
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 returnVerificationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverificationStateAsString()
.- 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.
-
toBuilder
public ViolationEvent.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ViolationEvent.Builder,ViolationEvent>
-
builder
public static ViolationEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends ViolationEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-