software.amazon.awssdk.services.iot.model

Class AbortCriteria

java.lang.Object

software.amazon.awssdk.services.iot.model.AbortCriteria

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AbortCriteria.Builder,AbortCriteria>

@Generated(value="software.amazon.awssdk:codegen")
public final class AbortCriteria
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AbortCriteria.Builder,AbortCriteria>

Details of abort criteria to define rules to abort the job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbortCriteria.Builder

Method Summary

Modifier and Type	Method and Description
AbortAction	action() The type of abort action to initiate a job abort.
String	actionAsString() The type of abort action to initiate a job abort.
static AbortCriteria.Builder	builder()
boolean	equals(Object obj)
JobExecutionFailureType	failureType() The type of job execution failure to define a rule to initiate a job abort.
String	failureTypeAsString() The type of job execution failure to define a rule to initiate a job abort.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	minNumberOfExecutedThings() Minimum number of executed things before evaluating an abort rule.
List<SdkField<?>>	sdkFields()
static Class<? extends AbortCriteria.Builder>	serializableBuilderClass()
Double	thresholdPercentage() The threshold as a percentage of the total number of executed things that will initiate a job abort.
AbortCriteria.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

failureType

public JobExecutionFailureType failureType()

The type of job execution failure to define a rule to 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 failure to define a rule to initiate a job abort.

See Also:

JobExecutionFailureType

failureTypeAsString

public String failureTypeAsString()

The type of job execution failure to define a rule to 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 failure to define a rule to initiate a job abort.

See Also:

JobExecutionFailureType

action

public AbortAction action()

The type of abort action to initiate a 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 abort action to initiate a job abort.

See Also:

AbortAction

actionAsString

public String actionAsString()

The type of abort action to initiate a 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 abort action to initiate a job abort.

See Also:

AbortAction

thresholdPercentage

public Double thresholdPercentage()

The threshold as a percentage of the total number of executed things that will initiate a job abort.

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

Returns:

The threshold as a percentage of the total number of executed things that will initiate a job abort.

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

minNumberOfExecutedThings

public Integer minNumberOfExecutedThings()

Minimum number of executed things before evaluating an abort rule.

Returns:

Minimum number of executed things before evaluating an abort rule.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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