Package com.oracle.bmc.limits.model

Class ResourceAvailability

java.lang.Object

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

com.oracle.bmc.limits.model.ResourceAvailability

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

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 ResourceAvailability.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	ResourceAvailability.Builder

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
ResourceAvailability(Long used, Long available, BigDecimal fractionalUsage, BigDecimal fractionalAvailability, BigDecimal effectiveQuotaValue)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ResourceAvailability.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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()
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

ResourceAvailability

@Deprecated
@ConstructorProperties({"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 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