com.oracle.bmc.limits.model

Class Quota

java.lang.Object

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

com.oracle.bmc.limits.model.Quota

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

Quotas are applied on top of the service limits and inherited through the nested compartment hierarchy. Quotas allow compartment admins to limit resource consumption and set boundaries around acceptable resource use. The term “quota” can be interpreted as the following: * 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 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 and Description
static class	Quota.Builder
static class	Quota.LifecycleState The quota’s current state.

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 and Description
Quota(String id, String compartmentId, String name, List<String> statements, List<ResourceLock> locks, 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)
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.
List<ResourceLock>	getLocks() Locks associated with this resource.
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 RFC 3339.
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={"id","compartmentId","name","statements","locks","description","timeCreated","lifecycleState","freeformTags","definedTags"})
public Quota(String id,
                                                                                                                                                                                     String compartmentId,
                                                                                                                                                                                     String name,
                                                                                                                                                                                     List<String> statements,
                                                                                                                                                                                     List<ResourceLock> locks,
                                                                                                                                                                                     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.

Returns:

the value

getCompartmentId

public String getCompartmentId()

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

Returns:

the value

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.

Returns:

the value

getStatements

public List<String> getStatements()

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

Returns:

the value

getLocks

public List<ResourceLock> getLocks()

Locks associated with this resource.

Returns:

the value

getDescription

public String getDescription()

The description you assign to the quota.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

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

Returns:

the value

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.

Returns:

the value

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"}

Returns:

the value

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"}}

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