com.oracle.bmc.usage.model

Class MonthlyRewardSummary

java.lang.Object

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

com.oracle.bmc.usage.model.MonthlyRewardSummary

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

Object describing the monthly rewards summary for the requested subscription ID.
Note: Objects should always be created or deserialized using the MonthlyRewardSummary.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 MonthlyRewardSummary.Builder, which maintain a set of all explicitly set fields called MonthlyRewardSummary.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	MonthlyRewardSummary.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 and Description
MonthlyRewardSummary(Float availableRewards, Float redeemedRewards, Float earnedRewards, Boolean isManual, Date timeRewardsExpired, Date timeRewardsEarned, Date timeUsageStarted, Date timeUsageEnded, Double usageAmount, Double eligibleUsageAmount, Double ineligibleUsageAmount, String usagePeriodKey) Deprecated.

Method Summary

Modifier and Type	Method and Description
static MonthlyRewardSummary.Builder	builder() Create a new builder.
boolean	equals(Object o)
Float	getAvailableRewards() The number of rewards available for a specific usage period.
Float	getEarnedRewards() The number of rewards earned for the specific usage period.
Double	getEligibleUsageAmount() The eligible usage amount for the usage period.
Double	getIneligibleUsageAmount() The ineligible usage amount for the usage period.
Boolean	getIsManual() The boolean parameter to indicate whether or not the available rewards are manually posted.
Float	getRedeemedRewards() The number of rewards redeemed for a specific month.
Date	getTimeRewardsEarned() The date and time when rewards accrue.
Date	getTimeRewardsExpired() The date and time when rewards expire.
Date	getTimeUsageEnded() The end date and time for the usage period.
Date	getTimeUsageStarted() The start date and time for the usage period.
Double	getUsageAmount() The usage amount for the usage period.
String	getUsagePeriodKey() The usage period ID.
int	hashCode()
MonthlyRewardSummary.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

MonthlyRewardSummary

@Deprecated
 @ConstructorProperties(value={"availableRewards","redeemedRewards","earnedRewards","isManual","timeRewardsExpired","timeRewardsEarned","timeUsageStarted","timeUsageEnded","usageAmount","eligibleUsageAmount","ineligibleUsageAmount","usagePeriodKey"})
public MonthlyRewardSummary(Float availableRewards,
                                                                                                                                                                                                                                                                                                   Float redeemedRewards,
                                                                                                                                                                                                                                                                                                   Float earnedRewards,
                                                                                                                                                                                                                                                                                                   Boolean isManual,
                                                                                                                                                                                                                                                                                                   Date timeRewardsExpired,
                                                                                                                                                                                                                                                                                                   Date timeRewardsEarned,
                                                                                                                                                                                                                                                                                                   Date timeUsageStarted,
                                                                                                                                                                                                                                                                                                   Date timeUsageEnded,
                                                                                                                                                                                                                                                                                                   Double usageAmount,
                                                                                                                                                                                                                                                                                                   Double eligibleUsageAmount,
                                                                                                                                                                                                                                                                                                   Double ineligibleUsageAmount,
                                                                                                                                                                                                                                                                                                   String usagePeriodKey)

Deprecated.

Method Detail

builder

public static MonthlyRewardSummary.Builder builder()

Create a new builder.

toBuilder

public MonthlyRewardSummary.Builder toBuilder()

getAvailableRewards

public Float getAvailableRewards()

The number of rewards available for a specific usage period.

Returns:

the value

getRedeemedRewards

public Float getRedeemedRewards()

The number of rewards redeemed for a specific month.

Returns:

the value

getEarnedRewards

public Float getEarnedRewards()

The number of rewards earned for the specific usage period.

Returns:

the value

getIsManual

public Boolean getIsManual()

The boolean parameter to indicate whether or not the available rewards are manually posted.

Returns:

the value

getTimeRewardsExpired

public Date getTimeRewardsExpired()

The date and time when rewards expire.

Returns:

the value

getTimeRewardsEarned

public Date getTimeRewardsEarned()

The date and time when rewards accrue.

Returns:

the value

getTimeUsageStarted

public Date getTimeUsageStarted()

The start date and time for the usage period.

Returns:

the value

getTimeUsageEnded

public Date getTimeUsageEnded()

The end date and time for the usage period.

Returns:

the value

getUsageAmount

public Double getUsageAmount()

The usage amount for the usage period.

Returns:

the value

getEligibleUsageAmount

public Double getEligibleUsageAmount()

The eligible usage amount for the usage period.

Returns:

the value

getIneligibleUsageAmount

public Double getIneligibleUsageAmount()

The ineligible usage amount for the usage period.

Returns:

the value

getUsagePeriodKey

public String getUsagePeriodKey()

The usage period ID.

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