Class AbortCriteria

java.lang.Object
software.amazon.awssdk.services.iot.model.AbortCriteria
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AbortCriteria.Builder,AbortCriteria>
@Generated("software.amazon.awssdk:codegen") public final class AbortCriteria extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AbortCriteria.Builder,AbortCriteria>

The criteria that determine when and how a job abort takes place.

See Also:

  • Method Details

    • failureType

      public final JobExecutionFailureType failureType()

      The type of job execution failures that can initiate a job abort.

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

      Returns:
      The type of job execution failures that can initiate a job abort.
      See Also:

    • failureTypeAsString

      public final String failureTypeAsString()

      The type of job execution failures that can initiate a job abort.

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

      Returns:
      The type of job execution failures that can initiate a job abort.
      See Also:

    • action

      public final AbortAction action()

      The type of job action to take to initiate the job abort.

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

      Returns:
      The type of job action to take to initiate the job abort.
      See Also:

    • actionAsString

      public final String actionAsString()

      The type of job action to take to initiate the job abort.

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

      Returns:
      The type of job action to take to initiate the job abort.
      See Also:

    • thresholdPercentage

      public final Double thresholdPercentage()

      The minimum percentage of job execution failures that must occur to initiate the job abort.

      Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

      Returns:
      The minimum percentage of job execution failures that must occur to initiate the job abort.

      Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

    • minNumberOfExecutedThings

      public final Integer minNumberOfExecutedThings()

      The minimum number of things which must receive job execution notifications before the job can be aborted.

      Returns:
      The minimum number of things which must receive job execution notifications before the job can be aborted.

    • toBuilder

      public AbortCriteria.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<AbortCriteria.Builder,AbortCriteria>
      Returns:
      a builder for type T

    • builder

      public static AbortCriteria.Builder builder()

    • serializableBuilderClass

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.