Package software.amazon.awssdk.services.apigateway.model

Class ThrottleSettings

java.lang.Object

software.amazon.awssdk.services.apigateway.model.ThrottleSettings

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ThrottleSettings.Builder,ThrottleSettings>

@Generated("software.amazon.awssdk:codegen")
public class ThrottleSettings
extends Object
implements StructuredPojo, ToCopyableBuilder<ThrottleSettings.Builder,ThrottleSettings>

The API request rate limits.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThrottleSettings.Builder

Method Summary

Modifier and Type	Method	Description
static ThrottleSettings.Builder	builder()
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.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Double	rateLimit()	The API request steady-state rate limit.
static Class<? extends ThrottleSettings.Builder>	serializableBuilderClass()
ThrottleSettings.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

burstLimit

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

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.

rateLimit

public Double rateLimit()

The API request steady-state rate limit.

Returns:

The API request steady-state rate limit.

toBuilder

public ThrottleSettings.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ThrottleSettings.Builder,ThrottleSettings>

Returns:

a builder for type T

builder

public static ThrottleSettings.Builder builder()

serializableBuilderClass

public static Class<? extends ThrottleSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

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