com.amazonaws.services.iot.model

Class AbortCriteria

java.lang.Object

com.amazonaws.services.iot.model.AbortCriteria

All Implemented Interfaces:

java.io.Serializable

public class AbortCriteria
extends java.lang.Object
implements java.io.Serializable

The criteria that determine when and how a job abort takes place.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbortCriteria()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAction() The type of job action to take to initiate the job abort.
java.lang.String	getFailureType() The type of job execution failures that can initiate a job abort.
java.lang.Integer	getMinNumberOfExecutedThings() The minimum number of things which must receive job execution notifications before the job can be aborted.
java.lang.Double	getThresholdPercentage() The minimum percentage of job execution failures that must occur to initiate the job abort.
int	hashCode()
void	setAction(AbortAction action) The type of job action to take to initiate the job abort.
void	setAction(java.lang.String action) The type of job action to take to initiate the job abort.
void	setFailureType(JobExecutionFailureType failureType) The type of job execution failures that can initiate a job abort.
void	setFailureType(java.lang.String failureType) The type of job execution failures that can initiate a job abort.
void	setMinNumberOfExecutedThings(java.lang.Integer minNumberOfExecutedThings) The minimum number of things which must receive job execution notifications before the job can be aborted.
void	setThresholdPercentage(java.lang.Double thresholdPercentage) The minimum percentage of job execution failures that must occur to initiate the job abort.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AbortCriteria	withAction(AbortAction action) The type of job action to take to initiate the job abort.
AbortCriteria	withAction(java.lang.String action) The type of job action to take to initiate the job abort.
AbortCriteria	withFailureType(JobExecutionFailureType failureType) The type of job execution failures that can initiate a job abort.
AbortCriteria	withFailureType(java.lang.String failureType) The type of job execution failures that can initiate a job abort.
AbortCriteria	withMinNumberOfExecutedThings(java.lang.Integer minNumberOfExecutedThings) The minimum number of things which must receive job execution notifications before the job can be aborted.
AbortCriteria	withThresholdPercentage(java.lang.Double thresholdPercentage) The minimum percentage of job execution failures that must occur to initiate the job abort.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbortCriteria

public AbortCriteria()

Method Detail

getFailureType

public java.lang.String getFailureType()

The type of job execution failures that can initiate a job abort.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

Returns:

The type of job execution failures that can initiate a job abort.

See Also:

JobExecutionFailureType

setFailureType

public void setFailureType(java.lang.String failureType)

The type of job execution failures that can initiate a job abort.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

Parameters:

failureType -

The type of job execution failures that can initiate a job abort.

See Also:

JobExecutionFailureType

withFailureType

public AbortCriteria withFailureType(java.lang.String failureType)

The type of job execution failures that can initiate a job abort.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

Parameters:

failureType -

The type of job execution failures that can initiate a job abort.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

JobExecutionFailureType

setFailureType

public void setFailureType(JobExecutionFailureType failureType)

The type of job execution failures that can initiate a job abort.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

Parameters:

failureType -

The type of job execution failures that can initiate a job abort.

See Also:

JobExecutionFailureType

withFailureType

public AbortCriteria withFailureType(JobExecutionFailureType failureType)

The type of job execution failures that can initiate a job abort.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: FAILED, REJECTED, TIMED_OUT, ALL

Parameters:

failureType -

The type of job execution failures that can initiate a job abort.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

JobExecutionFailureType

getAction

public java.lang.String getAction()

The type of job action to take to initiate the job abort.

Constraints:
Allowed Values: CANCEL

Returns:

The type of job action to take to initiate the job abort.

See Also:

AbortAction

setAction

public void setAction(java.lang.String action)

The type of job action to take to initiate the job abort.

Constraints:
Allowed Values: CANCEL

Parameters:

action -

The type of job action to take to initiate the job abort.

See Also:

AbortAction

withAction

public AbortCriteria withAction(java.lang.String action)

The type of job action to take to initiate the job abort.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CANCEL

Parameters:

action -

The type of job action to take to initiate the job abort.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AbortAction

setAction

public void setAction(AbortAction action)

The type of job action to take to initiate the job abort.

Constraints:
Allowed Values: CANCEL

Parameters:

action -

The type of job action to take to initiate the job abort.

See Also:

AbortAction

withAction

public AbortCriteria withAction(AbortAction action)

The type of job action to take to initiate the job abort.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CANCEL

Parameters:

action -

The type of job action to take to initiate the job abort.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AbortAction

getThresholdPercentage

public java.lang.Double getThresholdPercentage()

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Constraints:
Range: - 100

Returns:

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

setThresholdPercentage

public void setThresholdPercentage(java.lang.Double thresholdPercentage)

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Constraints:
Range: - 100

Parameters:

thresholdPercentage -

The minimum percentage of job execution failures that must occur to initiate the 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(java.lang.Double thresholdPercentage)

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: - 100

Parameters:

thresholdPercentage -

The minimum percentage of job execution failures that must occur to initiate the job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

Returns:

A reference to this updated object so that method calls can be chained together.

getMinNumberOfExecutedThings

public java.lang.Integer getMinNumberOfExecutedThings()

The minimum number of things which must receive job execution notifications before the job can be aborted.

Constraints:
Range: 1 -

Returns:

The minimum number of things which must receive job execution notifications before the job can be aborted.

setMinNumberOfExecutedThings

public void setMinNumberOfExecutedThings(java.lang.Integer minNumberOfExecutedThings)

The minimum number of things which must receive job execution notifications before the job can be aborted.

Constraints:
Range: 1 -

Parameters:

minNumberOfExecutedThings -

The minimum number of things which must receive job execution notifications before the job can be aborted.

withMinNumberOfExecutedThings

public AbortCriteria withMinNumberOfExecutedThings(java.lang.Integer minNumberOfExecutedThings)

The minimum number of things which must receive job execution notifications before the job can be aborted.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:

minNumberOfExecutedThings -

The minimum number of things which must receive job execution notifications before the job can be aborted.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object