Package com.oracle.bmc.apigateway.model

Class Quota

java.lang.Object

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

com.oracle.bmc.apigateway.model.Quota

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

Quota policy for a usage plan.
Note: Objects should always be created or deserialized using the Quota.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 Quota.Builder, which maintain a set of all explicitly set fields called Quota.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	Quota.Builder
static class	Quota.OperationOnBreach	What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
static class	Quota.ResetPolicy	The policy that controls when quotas will reset.
static class	Quota.Unit	The unit of time over which quotas are calculated.

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
Quota(Integer value, Quota.Unit unit, Quota.ResetPolicy resetPolicy, Quota.OperationOnBreach operationOnBreach)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Quota.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Quota.OperationOnBreach	getOperationOnBreach()	What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests
Quota.ResetPolicy	getResetPolicy()	The policy that controls when quotas will reset.
Quota.Unit	getUnit()	The unit of time over which quotas are calculated.
Integer	getValue()	The number of requests that can be made per time period.
int	hashCode()
Quota.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

Quota

@Deprecated
@ConstructorProperties({"value","unit","resetPolicy","operationOnBreach"})
public Quota(Integer value,
             Quota.Unit unit,
             Quota.ResetPolicy resetPolicy,
             Quota.OperationOnBreach operationOnBreach)

Deprecated.

Method Detail

builder

public static Quota.Builder builder()

Create a new builder.

toBuilder

public Quota.Builder toBuilder()

getValue

public Integer getValue()

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

Returns:

the value

getUnit

public Quota.Unit getUnit()

The unit of time over which quotas are calculated.

Example: MINUTE or MONTH

Returns:

the value

getResetPolicy

public Quota.ResetPolicy getResetPolicy()

The policy that controls when quotas will reset.

Example: CALENDAR

Returns:

the value

getOperationOnBreach

public Quota.OperationOnBreach getOperationOnBreach()

What the usage plan will do when a quota is breached: REJECT will allow no further requests ALLOW will continue to allow further requests

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