com.amazonaws.services.iot.model

Class ExponentialRolloutRate

java.lang.Object

com.amazonaws.services.iot.model.ExponentialRolloutRate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Allows you to create an exponential rate of rollout for a job.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExponentialRolloutRate()

Method Summary

Modifier and Type	Method and Description
ExponentialRolloutRate	clone()
boolean	equals(Object obj)
Integer	getBaseRatePerMinute() The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
Double	getIncrementFactor() The exponential factor to increase the rate of rollout for a job.
RateIncreaseCriteria	getRateIncreaseCriteria() The criteria to initiate the increase in rate of rollout for a job.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBaseRatePerMinute(Integer baseRatePerMinute) The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
void	setIncrementFactor(Double incrementFactor) The exponential factor to increase the rate of rollout for a job.
void	setRateIncreaseCriteria(RateIncreaseCriteria rateIncreaseCriteria) The criteria to initiate the increase in rate of rollout for a job.
String	toString() Returns a string representation of this object.
ExponentialRolloutRate	withBaseRatePerMinute(Integer baseRatePerMinute) The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.
ExponentialRolloutRate	withIncrementFactor(Double incrementFactor) The exponential factor to increase the rate of rollout for a job.
ExponentialRolloutRate	withRateIncreaseCriteria(RateIncreaseCriteria rateIncreaseCriteria) The criteria to initiate the increase in rate of rollout for a job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExponentialRolloutRate

public ExponentialRolloutRate()

Method Detail

setBaseRatePerMinute

public void setBaseRatePerMinute(Integer baseRatePerMinute)

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Parameters:

baseRatePerMinute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

getBaseRatePerMinute

public Integer getBaseRatePerMinute()

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Returns:

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

withBaseRatePerMinute

public ExponentialRolloutRate withBaseRatePerMinute(Integer baseRatePerMinute)

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Parameters:

baseRatePerMinute - The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

Returns:

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

setIncrementFactor

public void setIncrementFactor(Double incrementFactor)

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Parameters:

incrementFactor - The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

getIncrementFactor

public Double getIncrementFactor()

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Returns:

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

withIncrementFactor

public ExponentialRolloutRate withIncrementFactor(Double incrementFactor)

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Parameters:

incrementFactor - The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

Returns:

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

setRateIncreaseCriteria

public void setRateIncreaseCriteria(RateIncreaseCriteria rateIncreaseCriteria)

The criteria to initiate the increase in rate of rollout for a job.

Parameters:

rateIncreaseCriteria - The criteria to initiate the increase in rate of rollout for a job.

getRateIncreaseCriteria

public RateIncreaseCriteria getRateIncreaseCriteria()

The criteria to initiate the increase in rate of rollout for a job.

Returns:

The criteria to initiate the increase in rate of rollout for a job.

withRateIncreaseCriteria

public ExponentialRolloutRate withRateIncreaseCriteria(RateIncreaseCriteria rateIncreaseCriteria)

The criteria to initiate the increase in rate of rollout for a job.

Parameters:

rateIncreaseCriteria - The criteria to initiate the increase in rate of rollout for a job.

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 ExponentialRolloutRate 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.