com.amazonaws.services.apigateway.model

Class ThrottleSettings

java.lang.Object

com.amazonaws.services.apigateway.model.ThrottleSettings

All Implemented Interfaces:

Serializable, Cloneable

public class ThrottleSettings
extends Object
implements Serializable, Cloneable

The API request rate limits.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ThrottleSettings()

Method Summary

Modifier and Type	Method and Description
ThrottleSettings	clone()
boolean	equals(Object obj)
Integer	getBurstLimit() The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
Double	getRateLimit() The API request steady-state rate limit.
int	hashCode()
void	setBurstLimit(Integer burstLimit) The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
void	setRateLimit(Double rateLimit) The API request steady-state rate limit.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ThrottleSettings	withBurstLimit(Integer burstLimit) The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
ThrottleSettings	withRateLimit(Double rateLimit) The API request steady-state rate limit.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ThrottleSettings

public ThrottleSettings()

Method Detail

setBurstLimit

public void setBurstLimit(Integer burstLimit)

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

Parameters:

burstLimit - The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

getBurstLimit

public Integer getBurstLimit()

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

Returns:

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

withBurstLimit

public ThrottleSettings withBurstLimit(Integer burstLimit)

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

Parameters:

burstLimit - The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

Returns:

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

setRateLimit

public void setRateLimit(Double rateLimit)

The API request steady-state rate limit.

Parameters:

rateLimit - The API request steady-state rate limit.

getRateLimit

public Double getRateLimit()

The API request steady-state rate limit.

Returns:

The API request steady-state rate limit.

withRateLimit

public ThrottleSettings withRateLimit(Double rateLimit)

The API request steady-state rate limit.

Parameters:

rateLimit - The API request steady-state rate limit.

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; useful for testing and debugging.

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 ThrottleSettings clone()

Overrides:

clone in class Object