com.oracle.bmc.apigateway.model

Class RateLimitingPolicy

java.lang.Object

com.oracle.bmc.apigateway.model.RateLimitingPolicy

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class RateLimitingPolicy
extends Object

Limit the number of requests that should be handled for the specified window using a specfic key.
Note: Objects should always be created or deserialized using the RateLimitingPolicy.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the RateLimitingPolicy.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimitingPolicy.Builder
static class	RateLimitingPolicy.RateKey The key used to group requests together.

Constructor Summary

Constructors

Constructor and Description
RateLimitingPolicy(Integer rateInRequestsPerSecond, RateLimitingPolicy.RateKey rateKey) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RateLimitingPolicy.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
Integer	getRateInRequestsPerSecond() The maximum number of requests per second to allow.
RateLimitingPolicy.RateKey	getRateKey() The key used to group requests together.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingPolicy

@ConstructorProperties(value={"rateInRequestsPerSecond","rateKey"})
 @Deprecated
public RateLimitingPolicy(Integer rateInRequestsPerSecond,
                                                                                                           RateLimitingPolicy.RateKey rateKey)

Deprecated.

Method Detail

builder

public static RateLimitingPolicy.Builder builder()

Create a new builder.

getRateInRequestsPerSecond

public Integer getRateInRequestsPerSecond()

The maximum number of requests per second to allow.

getRateKey

public RateLimitingPolicy.RateKey getRateKey()

The key used to group requests together.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object