Package com.oracle.bmc.waas.model

Class AddressRateLimiting

java.lang.Object

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

com.oracle.bmc.waas.model.AddressRateLimiting

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

The IP rate limiting configuration.

Defines the amount of allowed requests from a unique IP address and the resulting block response code when that threshold is exceeded.
Note: Objects should always be created or deserialized using the AddressRateLimiting.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 AddressRateLimiting.Builder, which maintain a set of all explicitly set fields called AddressRateLimiting.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	AddressRateLimiting.Builder

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
AddressRateLimiting(Boolean isEnabled, Integer allowedRatePerAddress, Integer maxDelayedCountPerAddress, Integer blockResponseCode)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AddressRateLimiting.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getAllowedRatePerAddress()	The number of allowed requests per second from one IP address.
Integer	getBlockResponseCode()	The response status code returned when a request is blocked.
Boolean	getIsEnabled()	Enables or disables the address rate limiting Web Application Firewall feature.
Integer	getMaxDelayedCountPerAddress()	The maximum number of requests allowed to be queued before subsequent requests are dropped.
int	hashCode()
AddressRateLimiting.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

AddressRateLimiting

@Deprecated
@ConstructorProperties({"isEnabled","allowedRatePerAddress","maxDelayedCountPerAddress","blockResponseCode"})
public AddressRateLimiting(Boolean isEnabled,
                           Integer allowedRatePerAddress,
                           Integer maxDelayedCountPerAddress,
                           Integer blockResponseCode)

Deprecated.

Method Detail

builder

public static AddressRateLimiting.Builder builder()

Create a new builder.

toBuilder

public AddressRateLimiting.Builder toBuilder()

getIsEnabled

public Boolean getIsEnabled()

Enables or disables the address rate limiting Web Application Firewall feature.

Returns:

the value

getAllowedRatePerAddress

public Integer getAllowedRatePerAddress()

The number of allowed requests per second from one IP address.

If unspecified, defaults to 1.

Returns:

the value

getMaxDelayedCountPerAddress

public Integer getMaxDelayedCountPerAddress()

The maximum number of requests allowed to be queued before subsequent requests are dropped.

If unspecified, defaults to 10.

Returns:

the value

getBlockResponseCode

public Integer getBlockResponseCode()

The response status code returned when a request is blocked.

If unspecified, defaults to 503. The list of available response codes: 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.

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