Package software.amazon.awssdk.services.iot.model

Class ActiveViolation

java.lang.Object

software.amazon.awssdk.services.iot.model.ActiveViolation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ActiveViolation.Builder,ActiveViolation>

@Generated("software.amazon.awssdk:codegen")
public final class ActiveViolation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ActiveViolation.Builder,ActiveViolation>

Information about an active Device Defender security profile behavior violation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ActiveViolation.Builder

Method Summary

Modifier and Type	Method	Description
Behavior	behavior()	The behavior that is being violated.
static ActiveViolation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastViolationTime()	The time the most recent violation occurred.
MetricValue	lastViolationValue()	The value of the metric (the measurement) that caused the most recent violation.
List<SdkField<?>>	sdkFields()
String	securityProfileName()	The security profile with the behavior is in violation.
static Class<? extends ActiveViolation.Builder>	serializableBuilderClass()
String	thingName()	The name of the thing responsible for the active violation.
ActiveViolation.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.
String	violationId()	The ID of the active violation.
Instant	violationStartTime()	The time the violation started.

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 active violation.

Returns:

The ID of the active violation.

thingName

public final String thingName()

The name of the thing responsible for the active violation.

Returns:

The name of the thing responsible for the active violation.

securityProfileName

public final String securityProfileName()

The security profile with the behavior is in violation.

Returns:

The security profile with the behavior is in violation.

behavior

public final Behavior behavior()

The behavior that is being violated.

Returns:

The behavior that is being violated.

lastViolationValue

public final MetricValue lastViolationValue()

The value of the metric (the measurement) that caused the most recent violation.

Returns:

The value of the metric (the measurement) that caused the most recent violation.

violationEventAdditionalInfo

public final ViolationEventAdditionalInfo violationEventAdditionalInfo()

The details of a violation event.

Returns:

The details of a violation event.

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:

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

lastViolationTime

public final Instant lastViolationTime()

The time the most recent violation occurred.

Returns:

The time the most recent violation occurred.

violationStartTime

public final Instant violationStartTime()

The time the violation started.

Returns:

The time the violation started.

toBuilder

public ActiveViolation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ActiveViolation.Builder,ActiveViolation>

builder

public static ActiveViolation.Builder builder()

serializableBuilderClass

public static Class<? extends ActiveViolation.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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