Class AbortCriteria
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AbortCriteria.Builder,
AbortCriteria>
The criteria that determine when and how a job abort takes place.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AbortAction
action()
The type of job action to take to initiate the job abort.final String
The type of job action to take to initiate the job abort.static AbortCriteria.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final JobExecutionFailureType
The type of job execution failures that can initiate a job abort.final String
The type of job execution failures that can initiate a job abort.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The minimum number of things which must receive job execution notifications before the job can be aborted.static Class
<? extends AbortCriteria.Builder> final Double
The minimum percentage of job execution failures that must occur to initiate the job abort.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 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 returnJobExecutionFailureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureTypeAsString()
.- Returns:
- The type of job execution failures that can initiate a job abort.
- See Also:
-
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 returnJobExecutionFailureType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureTypeAsString()
.- Returns:
- The type of job execution failures that can initiate a job abort.
- See Also:
-
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 returnAbortAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The type of job action to take to initiate the job abort.
- See Also:
-
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 returnAbortAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The type of job action to take to initiate the job abort.
- See Also:
-
thresholdPercentage
The minimum percentage of job execution failures that must occur to initiate the job abort.
Amazon Web Services IoT Core 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.
Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
-
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
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<AbortCriteria.Builder,
AbortCriteria> - 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
-