com.oracle.bmc.apigateway.model

Class RateLimit

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.RateLimit

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

Rate-limiting policy for a usage plan.

Note: Objects should always be created or deserialized using the RateLimit.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 RateLimit.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RateLimit.Builder
static class	RateLimit.Unit The unit of time over which rate limits are calculated.

Constructor Summary

Constructors

Constructor and Description
RateLimit(Integer value, RateLimit.Unit unit) Deprecated.

Method Summary

Modifier and Type	Method and Description
static RateLimit.Builder	builder() Create a new builder.
boolean	equals(Object o)
RateLimit.Unit	getUnit() The unit of time over which rate limits are calculated.
Integer	getValue() The number of requests that can be made per time period.
int	hashCode()
RateLimit.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimit

@Deprecated
 @ConstructorProperties(value={"value","unit"})
public RateLimit(Integer value,
                                                                             RateLimit.Unit unit)

Deprecated.

Method Detail

builder

public static RateLimit.Builder builder()

Create a new builder.

toBuilder

public RateLimit.Builder toBuilder()

getValue

public Integer getValue()

The number of requests that can be made per time period.

Returns:

the value

getUnit

public RateLimit.Unit getUnit()

The unit of time over which rate limits are calculated. Example: SECOND

Returns:

the value

toString

public String toString()

Overrides:

toString in class 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 ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class ExplicitlySetBmcModel