Class IoTJobAbortCriteria
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IoTJobAbortCriteria.Builder,
IoTJobAbortCriteria>
Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
-
The number of things that receive the deployment exceeds the
minNumberOfExecutedThings
. -
The percentage of failures with type
failureType
exceeds thethresholdPercentage
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal IoTJobAbortAction
action()
The action to perform when the criteria are met.final String
The action to perform when the criteria are met.static IoTJobAbortCriteria.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The type of job deployment failure that can cancel a job.final String
The type of job deployment failure that can cancel a job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The minimum number of things that receive the configuration before the job can cancel.static Class
<? extends IoTJobAbortCriteria.Builder> final Double
The minimum percentage offailureType
failures that occur before the job can cancel.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnIoTJobExecutionFailureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureTypeAsString()
.- Returns:
- The type of job deployment failure that can cancel a job.
- See Also:
-
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 returnIoTJobExecutionFailureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureTypeAsString()
.- Returns:
- The type of job deployment failure that can cancel a job.
- See Also:
-
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 returnIoTJobAbortAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The action to perform when the criteria are met.
- See Also:
-
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 returnIoTJobAbortAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The action to perform when the criteria are met.
- See Also:
-
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
or10.99
, but not10.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
or10.99
, but not10.999
).
-
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
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 interfaceToCopyableBuilder<IoTJobAbortCriteria.Builder,
IoTJobAbortCriteria> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-