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

Class ListViolationEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.ListViolationEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListViolationEventsRequest.Builder,ListViolationEventsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListViolationEventsRequest
extends IotRequest
implements ToCopyableBuilder<ListViolationEventsRequest.Builder,ListViolationEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListViolationEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
BehaviorCriteriaType	behaviorCriteriaType()	The criteria for a behavior.
String	behaviorCriteriaTypeAsString()	The criteria for a behavior.
static ListViolationEventsRequest.Builder	builder()
Instant	endTime()	The end time for the alerts to be listed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	listSuppressedAlerts()	A list of all suppressed alerts.
Integer	maxResults()	The maximum number of results to return at one time.
String	nextToken()	The token for the next set of results.
List<SdkField<?>>	sdkFields()
String	securityProfileName()	A filter to limit results to those alerts generated by the specified security profile.
static Class<? extends ListViolationEventsRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The start time for the alerts to be listed.
String	thingName()	A filter to limit results to those alerts caused by the specified thing.
ListViolationEventsRequest.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).

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

startTime

public final Instant startTime()

The start time for the alerts to be listed.

Returns:

The start time for the alerts to be listed.

endTime

public final Instant endTime()

The end time for the alerts to be listed.

Returns:

The end time for the alerts to be listed.

thingName

public final String thingName()

A filter to limit results to those alerts caused by the specified thing.

Returns:

A filter to limit results to those alerts caused by the specified thing.

securityProfileName

public final String securityProfileName()

A filter to limit results to those alerts generated by the specified security profile.

Returns:

A filter to limit results to those alerts generated by the specified security profile.

behaviorCriteriaType

public final BehaviorCriteriaType behaviorCriteriaType()

The criteria for a behavior.

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

Returns:

The criteria for a behavior.

See Also:

BehaviorCriteriaType

behaviorCriteriaTypeAsString

public final String behaviorCriteriaTypeAsString()

The criteria for a behavior.

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

Returns:

The criteria for a behavior.

See Also:

BehaviorCriteriaType

listSuppressedAlerts

public final Boolean listSuppressedAlerts()

A list of all suppressed alerts.

Returns:

A list of all suppressed alerts.

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

nextToken

public final String nextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

maxResults

public final Integer maxResults()

The maximum number of results to return at one time.

Returns:

The maximum number of results to return at one time.

toBuilder

public ListViolationEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListViolationEventsRequest.Builder,ListViolationEventsRequest>

Specified by:

toBuilder in class IotRequest

builder

public static ListViolationEventsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo