@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class IoTJobAbortCriteria extends Object implements Serializable, Cloneable, StructuredPojo
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 the thresholdPercentage
.
Constructor and Description |
---|
IoTJobAbortCriteria() |
Modifier and Type | Method and Description |
---|---|
IoTJobAbortCriteria |
clone() |
boolean |
equals(Object obj) |
String |
getAction()
The action to perform when the criteria are met.
|
String |
getFailureType()
The type of job deployment failure that can cancel a job.
|
Integer |
getMinNumberOfExecutedThings()
The minimum number of things that receive the configuration before the job can cancel.
|
Double |
getThresholdPercentage()
The minimum percentage of
failureType failures that occur before the job can cancel. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAction(String action)
The action to perform when the criteria are met.
|
void |
setFailureType(String failureType)
The type of job deployment failure that can cancel a job.
|
void |
setMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
The minimum number of things that receive the configuration before the job can cancel.
|
void |
setThresholdPercentage(Double thresholdPercentage)
The minimum percentage of
failureType failures that occur before the job can cancel. |
String |
toString()
Returns a string representation of this object.
|
IoTJobAbortCriteria |
withAction(IoTJobAbortAction action)
The action to perform when the criteria are met.
|
IoTJobAbortCriteria |
withAction(String action)
The action to perform when the criteria are met.
|
IoTJobAbortCriteria |
withFailureType(IoTJobExecutionFailureType failureType)
The type of job deployment failure that can cancel a job.
|
IoTJobAbortCriteria |
withFailureType(String failureType)
The type of job deployment failure that can cancel a job.
|
IoTJobAbortCriteria |
withMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
The minimum number of things that receive the configuration before the job can cancel.
|
IoTJobAbortCriteria |
withThresholdPercentage(Double thresholdPercentage)
The minimum percentage of
failureType failures that occur before the job can cancel. |
public void setFailureType(String failureType)
The type of job deployment failure that can cancel a job.
failureType
- The type of job deployment failure that can cancel a job.IoTJobExecutionFailureType
public String getFailureType()
The type of job deployment failure that can cancel a job.
IoTJobExecutionFailureType
public IoTJobAbortCriteria withFailureType(String failureType)
The type of job deployment failure that can cancel a job.
failureType
- The type of job deployment failure that can cancel a job.IoTJobExecutionFailureType
public IoTJobAbortCriteria withFailureType(IoTJobExecutionFailureType failureType)
The type of job deployment failure that can cancel a job.
failureType
- The type of job deployment failure that can cancel a job.IoTJobExecutionFailureType
public void setAction(String action)
The action to perform when the criteria are met.
action
- The action to perform when the criteria are met.IoTJobAbortAction
public String getAction()
The action to perform when the criteria are met.
IoTJobAbortAction
public IoTJobAbortCriteria withAction(String action)
The action to perform when the criteria are met.
action
- The action to perform when the criteria are met.IoTJobAbortAction
public IoTJobAbortCriteria withAction(IoTJobAbortAction action)
The action to perform when the criteria are met.
action
- The action to perform when the criteria are met.IoTJobAbortAction
public void setThresholdPercentage(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
).
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
).
public Double getThresholdPercentage()
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
).
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
).
public IoTJobAbortCriteria withThresholdPercentage(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
).
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
).
public void setMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
The minimum number of things that receive the configuration before the job can cancel.
minNumberOfExecutedThings
- The minimum number of things that receive the configuration before the job can cancel.public Integer getMinNumberOfExecutedThings()
The minimum number of things that receive the configuration before the job can cancel.
public IoTJobAbortCriteria withMinNumberOfExecutedThings(Integer minNumberOfExecutedThings)
The minimum number of things that receive the configuration before the job can cancel.
minNumberOfExecutedThings
- The minimum number of things that receive the configuration before the job can cancel.public String toString()
toString
in class Object
Object.toString()
public IoTJobAbortCriteria clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.