com.oracle.bmc.limits.model

Class ResourceAvailability

java.lang.Object

com.oracle.bmc.limits.model.ResourceAvailability

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

The availability of a given resource limit, based on the usage, tenant service limits, and quotas set for the tenancy. Note: We cannot guarantee this data for all the limits. In such cases, these fields will be empty.

Note: Objects should always be created or deserialized using the ResourceAvailability.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 ResourceAvailability.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	ResourceAvailability.Builder

Constructor Summary

Constructors

Constructor and Description
ResourceAvailability(Long used, Long available, BigDecimal fractionalUsage, BigDecimal fractionalAvailability, BigDecimal effectiveQuotaValue) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ResourceAvailability.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
Long	getAvailable() The count of available resources.
BigDecimal	getEffectiveQuotaValue() The effective quota value for the given compartment.
BigDecimal	getFractionalAvailability() The most accurate count of available resources.
BigDecimal	getFractionalUsage() The current most accurate usage in the given compartment.
Long	getUsed() The current usage in the given compartment.
int	hashCode()
ResourceAvailability.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAvailability

@Deprecated
 @ConstructorProperties(value={"used","available","fractionalUsage","fractionalAvailability","effectiveQuotaValue"})
public ResourceAvailability(Long used,
                                                                                                                                                             Long available,
                                                                                                                                                             BigDecimal fractionalUsage,
                                                                                                                                                             BigDecimal fractionalAvailability,
                                                                                                                                                             BigDecimal effectiveQuotaValue)

Deprecated.

Method Detail

builder

public static ResourceAvailability.Builder builder()

Create a new builder.

toBuilder

public ResourceAvailability.Builder toBuilder()

getUsed

public Long getUsed()

The current usage in the given compartment. To support resources with fractional counts, the field rounds up to the nearest integer.

Returns:

the value

getAvailable

public Long getAvailable()

The count of available resources. To support resources with fractional counts, the field rounds down to the nearest integer.

Returns:

the value

getFractionalUsage

public BigDecimal getFractionalUsage()

The current most accurate usage in the given compartment.

Returns:

the value

getFractionalAvailability

public BigDecimal getFractionalAvailability()

The most accurate count of available resources.

Returns:

the value

getEffectiveQuotaValue

public BigDecimal getEffectiveQuotaValue()

The effective quota value for the given compartment. This field is only present if there is a current quota policy affecting the current resource in the target region or availability domain.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get__explicitlySet__

public Set<String> get__explicitlySet__()