software.amazon.awssdk.services.iot.model

Class AwsJobAbortCriteria

java.lang.Object

software.amazon.awssdk.services.iot.model.AwsJobAbortCriteria

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsJobAbortCriteria.Builder

Method Summary

Modifier and Type	Method and Description
AwsJobAbortCriteriaAbortAction	action() The type of job action to take to initiate the job abort.
String	actionAsString() The type of job action to take to initiate the job abort.
static AwsJobAbortCriteria.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
AwsJobAbortCriteriaFailureType	failureType() The type of job execution failures that can initiate a job abort.
String	failureTypeAsString() The type of job execution failures that can initiate a job abort.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	minNumberOfExecutedThings() The minimum number of things which must receive job execution notifications before the job can be aborted.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsJobAbortCriteria.Builder>	serializableBuilderClass()
Double	thresholdPercentage() The minimum percentage of job execution failures that must occur to initiate the job abort.
AwsJobAbortCriteria.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

failureType

public final AwsJobAbortCriteriaFailureType 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 AwsJobAbortCriteriaFailureType.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:

AwsJobAbortCriteriaFailureType

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 AwsJobAbortCriteriaFailureType.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:

AwsJobAbortCriteriaFailureType

action

public final AwsJobAbortCriteriaAbortAction 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 AwsJobAbortCriteriaAbortAction.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:

AwsJobAbortCriteriaAbortAction

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 AwsJobAbortCriteriaAbortAction.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:

AwsJobAbortCriteriaAbortAction

thresholdPercentage

public final Double thresholdPercentage()

The minimum percentage of job execution failures that must occur to initiate the 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 minimum percentage of job execution failures that must occur to initiate the 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 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 AwsJobAbortCriteria.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<AwsJobAbortCriteria.Builder,AwsJobAbortCriteria>

Returns:

a builder for type T

builder

public static AwsJobAbortCriteria.Builder builder()

serializableBuilderClass

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