Package software.amazon.awssdk.services.greengrassv2.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IoTJobAbortCriteria.Builder

Method Summary

Modifier and Type	Method	Description
IoTJobAbortAction	action()	The action to perform when the criteria are met.
String	actionAsString()	The action to perform when the criteria are met.
static IoTJobAbortCriteria.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
IoTJobExecutionFailureType	failureType()	The type of job deployment failure that can cancel a job.
String	failureTypeAsString()	The type of job deployment failure that can cancel a job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	minNumberOfExecutedThings()	The minimum number of things that receive the configuration before the job can cancel.
List<SdkField<?>>	sdkFields()
static Class<? extends IoTJobAbortCriteria.Builder>	serializableBuilderClass()
Double	thresholdPercentage()	The minimum percentage of failureType failures that occur before the job can cancel.
IoTJobAbortCriteria.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

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:

IoTJobExecutionFailureType

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:

IoTJobExecutionFailureType

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:

IoTJobAbortAction

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:

IoTJobAbortAction

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

Specified by:

toBuilder in interface ToCopyableBuilder<IoTJobAbortCriteria.Builder,IoTJobAbortCriteria>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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