Class IoTJobAbortCriteria

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

Contains criteria that define when and how to cancel a job.

The deployment stops if the following conditions are true:

  1. The number of things that receive the deployment exceeds the minNumberOfExecutedThings.

  2. The percentage of failures with type failureType exceeds the thresholdPercentage.

See Also:

  • Method Details

    • failureType

      public final IoTJobExecutionFailureType failureType()

      The type of job deployment failure that can cancel a job.

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

      Returns:
      The type of job deployment failure that can cancel a job.
      See Also:

    • failureTypeAsString

      public final String failureTypeAsString()

      The type of job deployment failure that can cancel a job.

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

      Returns:
      The type of job deployment failure that can cancel a job.
      See Also:

    • action

      public final IoTJobAbortAction action()

      The action to perform when the criteria are met.

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

      Returns:
      The action to perform when the criteria are met.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action to perform when the criteria are met.

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

      Returns:
      The action to perform when the criteria are met.
      See Also:

    • thresholdPercentage

      public final Double thresholdPercentage()

      The minimum percentage of failureType failures that occur before the job can cancel.

      This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

      Returns:
      The minimum percentage of failureType failures that occur before the job can cancel.

      This parameter supports up to two digits after the decimal (for example, you can specify 10.9 or 10.99, but not 10.999).

    • minNumberOfExecutedThings

      public final Integer minNumberOfExecutedThings()

      The minimum number of things that receive the configuration before the job can cancel.

      Returns:
      The minimum number of things that receive the configuration before the job can cancel.

    • toBuilder

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

    • builder

      public static IoTJobAbortCriteria.Builder builder()

    • serializableBuilderClass

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