Package com.oracle.bmc.usageapi.model

Class UsageSummary

java.lang.Object

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

com.oracle.bmc.usageapi.model.UsageSummary

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

The usage store result.
Note: Objects should always be created or deserialized using the UsageSummary.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 UsageSummary.Builder, which maintain a set of all explicitly set fields called UsageSummary.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	UsageSummary.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

UsageSummary(String tenantId, String tenantName, String compartmentId, String compartmentPath, String compartmentName, String service, String resourceName, String resourceId, String region, String ad, BigDecimal weight, String shape, String skuPartNumber, String skuName, String unit, BigDecimal discount, BigDecimal listRate, String platform, Date timeUsageStarted, Date timeUsageEnded, BigDecimal computedAmount, BigDecimal computedQuantity, String attributedCost, String attributedUsage, String overagesFlag, BigDecimal unitPrice, String currency, String subscriptionId, String overage, Boolean isForecast, List<Tag> tags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static UsageSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAd()	The availability domain of the usage.
String	getAttributedCost()	The attributed cost with a max value of 9999999999.999999999999 and a minimum value of 0.
String	getAttributedUsage()	The attributed usage with a max value of 9999999999.999999999999 and a minimum value of 0.
String	getCompartmentId()	The compartment OCID.
String	getCompartmentName()	The compartment name.
String	getCompartmentPath()	The compartment path, starting from root.
BigDecimal	getComputedAmount()	The computed cost.
BigDecimal	getComputedQuantity()	The usage number.
String	getCurrency()	The price currency.
BigDecimal	getDiscount()	The discretionary discount applied to the SKU.
Boolean	getIsForecast()	The forecasted data.
BigDecimal	getListRate()	The SKU list rate (not discount).
String	getOverage()	The overage usage.
String	getOveragesFlag()	The SPM OverageFlag.
String	getPlatform()	Platform for the cost.
String	getRegion()	The region of the usage.
String	getResourceId()	The resource OCID that is incurring the cost.
String	getResourceName()	The resource name that is incurring the cost.
String	getService()	The service name that is incurring the cost.
String	getShape()	The resource shape.
String	getSkuName()	The SKU friendly name.
String	getSkuPartNumber()	The SKU part number.
String	getSubscriptionId()	The subscription ID.
List<Tag>	getTags()	For grouping, a tag definition.
String	getTenantId()	The tenancy OCID.
String	getTenantName()	The tenancy name.
Date	getTimeUsageEnded()	The usage end time.
Date	getTimeUsageStarted()	The usage start time.
String	getUnit()	The usage unit.
BigDecimal	getUnitPrice()	The price per unit.
BigDecimal	getWeight()	The resource size being metered.
int	hashCode()
UsageSummary.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

UsageSummary

@Deprecated
@ConstructorProperties({"tenantId","tenantName","compartmentId","compartmentPath","compartmentName","service","resourceName","resourceId","region","ad","weight","shape","skuPartNumber","skuName","unit","discount","listRate","platform","timeUsageStarted","timeUsageEnded","computedAmount","computedQuantity","attributedCost","attributedUsage","overagesFlag","unitPrice","currency","subscriptionId","overage","isForecast","tags"})
public UsageSummary(String tenantId,
                    String tenantName,
                    String compartmentId,
                    String compartmentPath,
                    String compartmentName,
                    String service,
                    String resourceName,
                    String resourceId,
                    String region,
                    String ad,
                    BigDecimal weight,
                    String shape,
                    String skuPartNumber,
                    String skuName,
                    String unit,
                    BigDecimal discount,
                    BigDecimal listRate,
                    String platform,
                    Date timeUsageStarted,
                    Date timeUsageEnded,
                    BigDecimal computedAmount,
                    BigDecimal computedQuantity,
                    String attributedCost,
                    String attributedUsage,
                    String overagesFlag,
                    BigDecimal unitPrice,
                    String currency,
                    String subscriptionId,
                    String overage,
                    Boolean isForecast,
                    List<Tag> tags)

Deprecated.

Method Detail

builder

public static UsageSummary.Builder builder()

Create a new builder.

toBuilder

public UsageSummary.Builder toBuilder()

getTenantId

public String getTenantId()

The tenancy OCID.

Returns:

the value

getTenantName

public String getTenantName()

The tenancy name.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The compartment OCID.

Returns:

the value

getCompartmentPath

public String getCompartmentPath()

The compartment path, starting from root.

Returns:

the value

getCompartmentName

public String getCompartmentName()

The compartment name.

Returns:

the value

getService

public String getService()

The service name that is incurring the cost.

Returns:

the value

getResourceName

public String getResourceName()

The resource name that is incurring the cost.

Returns:

the value

getResourceId

public String getResourceId()

The resource OCID that is incurring the cost.

Returns:

the value

getRegion

public String getRegion()

The region of the usage.

Returns:

the value

getAd

public String getAd()

The availability domain of the usage.

Returns:

the value

getWeight

public BigDecimal getWeight()

The resource size being metered.

Returns:

the value

getShape

public String getShape()

The resource shape.

Returns:

the value

getSkuPartNumber

public String getSkuPartNumber()

The SKU part number.

Returns:

the value

getSkuName

public String getSkuName()

The SKU friendly name.

Returns:

the value

getUnit

public String getUnit()

The usage unit.

Returns:

the value

getDiscount

public BigDecimal getDiscount()

The discretionary discount applied to the SKU.

Returns:

the value

getListRate

public BigDecimal getListRate()

The SKU list rate (not discount).

Returns:

the value

getPlatform

public String getPlatform()

Platform for the cost.

Returns:

the value

getTimeUsageStarted

public Date getTimeUsageStarted()

The usage start time.

Returns:

the value

getTimeUsageEnded

public Date getTimeUsageEnded()

The usage end time.

Returns:

the value

getComputedAmount

public BigDecimal getComputedAmount()

The computed cost.

Returns:

the value

getComputedQuantity

public BigDecimal getComputedQuantity()

The usage number.

Returns:

the value

getAttributedCost

public String getAttributedCost()

The attributed cost with a max value of 9999999999.999999999999 and a minimum value of 0.

Returns:

the value

getAttributedUsage

public String getAttributedUsage()

The attributed usage with a max value of 9999999999.999999999999 and a minimum value of 0.

Returns:

the value

getOveragesFlag

public String getOveragesFlag()

The SPM OverageFlag.

Returns:

the value

getUnitPrice

public BigDecimal getUnitPrice()

The price per unit.

Returns:

the value

getCurrency

public String getCurrency()

The price currency.

Returns:

the value

getSubscriptionId

public String getSubscriptionId()

The subscription ID.

Returns:

the value

getOverage

public String getOverage()

The overage usage.

Returns:

the value

getIsForecast

public Boolean getIsForecast()

The forecasted data.

Returns:

the value

getTags

public List<Tag> getTags()

For grouping, a tag definition.

For filtering, a definition and key.

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