Package com.oracle.bmc.apigateway.model

Class RateLimitingPolicy

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.RateLimitingPolicy

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class RateLimitingPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 RateLimitingPolicy.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RateLimitingPolicy.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getRateInRequestsPerSecond()	The maximum number of requests per second to allow.
RateLimitingPolicy.RateKey	getRateKey()	The key used to group requests together.
int	hashCode()
RateLimitingPolicy.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimitingPolicy

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

Deprecated.

Method Detail

builder

public static RateLimitingPolicy.Builder builder()

Create a new builder.

toBuilder

public RateLimitingPolicy.Builder toBuilder()

getRateInRequestsPerSecond

public Integer getRateInRequestsPerSecond()

The maximum number of requests per second to allow.

Returns:

the value

getRateKey

public RateLimitingPolicy.RateKey getRateKey()

The key used to group requests together.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel