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>

  • Method Details

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

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

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

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

    • 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()
      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<ListViolationEventsRequest.Builder,ListViolationEventsRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T

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