software.amazon.awssdk.services.iot.model

Class ListActiveViolationsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListActiveViolationsRequest.Builder,ListActiveViolationsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListActiveViolationsRequest.Builder

Method Summary

Modifier and Type	Method and Description
BehaviorCriteriaType	behaviorCriteriaType() The criteria for a behavior.
String	behaviorCriteriaTypeAsString() The criteria for a behavior.
static ListActiveViolationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() The name of the Device Defender security profile for which violations are listed.
static Class<? extends ListActiveViolationsRequest.Builder>	serializableBuilderClass()
String	thingName() The name of the thing whose active violations are listed.
ListActiveViolationsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

thingName

public final String thingName()

The name of the thing whose active violations are listed.

Returns:

The name of the thing whose active violations are listed.

securityProfileName

public final String securityProfileName()

The name of the Device Defender security profile for which violations are listed.

Returns:

The name of the Device Defender security profile for which violations are listed.

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.

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 ListActiveViolationsRequest.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<ListActiveViolationsRequest.Builder,ListActiveViolationsRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static ListActiveViolationsRequest.Builder builder()

serializableBuilderClass

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

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.