com.oracle.bmc.limits.model

Class Quota

java.lang.Object

com.oracle.bmc.limits.model.Quota

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

Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. They allow compartment admins to limit resource consumption and set boundaries around acceptable resource use. The word "quota" is used by people in different ways:

• An individual statement written in the declarative language
• A collection of statements in a single, named "quota" object (which has an Oracle Cloud ID (OCID) assigned to it)
• The overall body of quotas your organization uses to control access to resources

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 __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	Quota.Builder
static class	Quota.LifecycleState The quota’s current state.

Constructor Summary

Constructors

Constructor and Description
Quota(String id, String compartmentId, String name, List<String> statements, String description, Date timeCreated, Quota.LifecycleState lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Quota.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment containing the resource this quota applies to.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() The description you assign to the quota.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the quota.
Quota.LifecycleState	getLifecycleState() The quota’s current state.
String	getName() The name you assign to the quota during creation.
List<String>	getStatements() An array of one or more quota statements written in the declarative quota statement language.
Date	getTimeCreated() Date and time the quota was created, in the format defined by RFC3339.
int	hashCode()
Quota.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Quota

@ConstructorProperties(value={"id","compartmentId","name","statements","description","timeCreated","lifecycleState","freeformTags","definedTags"})
 @Deprecated
public Quota(String id,
                                                                                                                                                                             String compartmentId,
                                                                                                                                                                             String name,
                                                                                                                                                                             List<String> statements,
                                                                                                                                                                             String description,
                                                                                                                                                                             Date timeCreated,
                                                                                                                                                                             Quota.LifecycleState lifecycleState,
                                                                                                                                                                             Map<String,String> freeformTags,
                                                                                                                                                                             Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static Quota.Builder builder()

Create a new builder.

toBuilder

public Quota.Builder toBuilder()

getId

public String getId()

The OCID of the quota.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the resource this quota applies to.

getName

public String getName()

The name you assign to the quota during creation. The name must be unique across all quotas in the tenancy and cannot be changed.

getStatements

public List<String> getStatements()

An array of one or more quota statements written in the declarative quota statement language.

getDescription

public String getDescription()

The description you assign to the quota.

getTimeCreated

public Date getTimeCreated()

Date and time the quota was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

getLifecycleState

public Quota.LifecycleState getLifecycleState()

The quota’s current state. After creating a quota, make sure its lifecycleState is set to ACTIVE before using it.

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

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