AbortCriteria (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.AbortCriteria

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbortCriteria
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbortCriteria()

Constructors
Constructor and Description
`AbortCriteria()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbortCriteria`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The type of abort action to initiate a job abort.
`String`	`getFailureType()` The type of job execution failure to define a rule to initiate a job abort.
`Integer`	`getMinNumberOfExecutedThings()` Minimum number of executed things before evaluating an abort rule.
`Double`	`getThresholdPercentage()` The threshold as a percentage of the total number of executed things that will initiate a job abort.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` The type of abort action to initiate a job abort.
`void`	`setFailureType(String failureType)` The type of job execution failure to define a rule to initiate a job abort.
`void`	`setMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)` Minimum number of executed things before evaluating an abort rule.
`void`	`setThresholdPercentage(Double thresholdPercentage)` The threshold as a percentage of the total number of executed things that will initiate a job abort.
`String`	`toString()` Returns a string representation of this object.
`AbortCriteria`	`withAction(AbortAction action)` The type of abort action to initiate a job abort.
`AbortCriteria`	`withAction(String action)` The type of abort action to initiate a job abort.
`AbortCriteria`	`withFailureType(JobExecutionFailureType failureType)` The type of job execution failure to define a rule to initiate a job abort.
`AbortCriteria`	`withFailureType(String failureType)` The type of job execution failure to define a rule to initiate a job abort.
`AbortCriteria`	`withMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)` Minimum number of executed things before evaluating an abort rule.
`AbortCriteria`	`withThresholdPercentage(Double thresholdPercentage)` The threshold as a percentage of the total number of executed things that will initiate a job abort.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AbortCriteria
```
public AbortCriteria()
```
- Method Detail
  - setFailureType
```
public void setFailureType(String failureType)
```
    The type of job execution failure to define a rule to initiate a job abort.
    
    Parameters:
    
    failureType - The type of job execution failure to define a rule to initiate a job abort.
    
    See Also:
    
    JobExecutionFailureType
  - getFailureType
```
public String getFailureType()
```
    The type of job execution failure to define a rule to initiate a job abort.
    
    Returns:
    
    The type of job execution failure to define a rule to initiate a job abort.
    
    See Also:
    
    JobExecutionFailureType
  - withFailureType
```
public AbortCriteria withFailureType(String failureType)
```
    The type of job execution failure to define a rule to initiate a job abort.
    
    Parameters:
    
    failureType - The type of job execution failure to define a rule to initiate a job abort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionFailureType
  - withFailureType
```
public AbortCriteria withFailureType(JobExecutionFailureType failureType)
```
    The type of job execution failure to define a rule to initiate a job abort.
    
    Parameters:
    
    failureType - The type of job execution failure to define a rule to initiate a job abort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobExecutionFailureType
  - setAction
```
public void setAction(String action)
```
    The type of abort action to initiate a job abort.
    
    Parameters:
    
    action - The type of abort action to initiate a job abort.
    
    See Also:
    
    AbortAction
  - getAction
```
public String getAction()
```
    The type of abort action to initiate a job abort.
    
    Returns:
    
    The type of abort action to initiate a job abort.
    
    See Also:
    
    AbortAction
  - withAction
```
public AbortCriteria withAction(String action)
```
    The type of abort action to initiate a job abort.
    
    Parameters:
    
    action - The type of abort action to initiate a job abort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AbortAction
  - withAction
```
public AbortCriteria withAction(AbortAction action)
```
    The type of abort action to initiate a job abort.
    
    Parameters:
    
    action - The type of abort action to initiate a job abort.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AbortAction
  - setThresholdPercentage
```
public void setThresholdPercentage(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).
    
    Parameters:
    
    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).
  - getThresholdPercentage
```
public Double getThresholdPercentage()
```
    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).
  - withThresholdPercentage
```
public AbortCriteria withThresholdPercentage(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinNumberOfExecutedThings
```
public void setMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
```
    Minimum number of executed things before evaluating an abort rule.
    
    Parameters:
    
    minNumberOfExecutedThings - Minimum number of executed things before evaluating an abort rule.
  - getMinNumberOfExecutedThings
```
public Integer getMinNumberOfExecutedThings()
```
    Minimum number of executed things before evaluating an abort rule.
    
    Returns:
    
    Minimum number of executed things before evaluating an abort rule.
  - withMinNumberOfExecutedThings
```
public AbortCriteria withMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
```
    Minimum number of executed things before evaluating an abort rule.
    
    Parameters:
    
    minNumberOfExecutedThings - Minimum number of executed things before evaluating an abort rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AbortCriteria clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class AbortCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbortCriteria

Method Detail

setFailureType

getFailureType

withFailureType

withFailureType

setAction

getAction

withAction

withAction

setThresholdPercentage

getThresholdPercentage

withThresholdPercentage

setMinNumberOfExecutedThings

getMinNumberOfExecutedThings

withMinNumberOfExecutedThings

toString

equals

hashCode

clone

marshall