MonthlyRewardSummary¶

class oci.usage.models.MonthlyRewardSummary(**kwargs)¶

Bases: object

Object describing the monthly rewards summary for the requested subscription ID.

Methods

__init__(**kwargs) Initializes a new MonthlyRewardSummary object with values from keyword arguments.

Attributes

`available_rewards`	Gets the available_rewards of this MonthlyRewardSummary.
`earned_rewards`	Gets the earned_rewards of this MonthlyRewardSummary.
`eligible_usage_amount`	Gets the eligible_usage_amount of this MonthlyRewardSummary.
`ineligible_usage_amount`	Gets the ineligible_usage_amount of this MonthlyRewardSummary.
`is_manual`	Gets the is_manual of this MonthlyRewardSummary.
`redeemed_rewards`	Gets the redeemed_rewards of this MonthlyRewardSummary.
`time_rewards_earned`	Gets the time_rewards_earned of this MonthlyRewardSummary.
`time_rewards_expired`	Gets the time_rewards_expired of this MonthlyRewardSummary.
`time_usage_ended`	Gets the time_usage_ended of this MonthlyRewardSummary.
`time_usage_started`	Gets the time_usage_started of this MonthlyRewardSummary.
`usage_amount`	Gets the usage_amount of this MonthlyRewardSummary.
`usage_period_key`	Gets the usage_period_key of this MonthlyRewardSummary.

__init__(**kwargs)¶

Initializes a new MonthlyRewardSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

available_rewards (float) – The value to assign to the available_rewards property of this MonthlyRewardSummary.
redeemed_rewards (float) – The value to assign to the redeemed_rewards property of this MonthlyRewardSummary.
earned_rewards (float) – The value to assign to the earned_rewards property of this MonthlyRewardSummary.
is_manual (bool) – The value to assign to the is_manual property of this MonthlyRewardSummary.
time_rewards_expired (datetime) – The value to assign to the time_rewards_expired property of this MonthlyRewardSummary.
time_rewards_earned (datetime) – The value to assign to the time_rewards_earned property of this MonthlyRewardSummary.
time_usage_started (datetime) – The value to assign to the time_usage_started property of this MonthlyRewardSummary.
time_usage_ended (datetime) – The value to assign to the time_usage_ended property of this MonthlyRewardSummary.
usage_amount (float) – The value to assign to the usage_amount property of this MonthlyRewardSummary.
eligible_usage_amount (float) – The value to assign to the eligible_usage_amount property of this MonthlyRewardSummary.
ineligible_usage_amount (float) – The value to assign to the ineligible_usage_amount property of this MonthlyRewardSummary.
usage_period_key (str) – The value to assign to the usage_period_key property of this MonthlyRewardSummary.

available_rewards¶

Gets the available_rewards of this MonthlyRewardSummary. The number of rewards available for a specific usage period.

Returns:	The available_rewards of this MonthlyRewardSummary.
Return type:	float

earned_rewards¶

Gets the earned_rewards of this MonthlyRewardSummary. The number of rewards earned for the specific usage period.

Returns:	The earned_rewards of this MonthlyRewardSummary.
Return type:	float

eligible_usage_amount¶

Gets the eligible_usage_amount of this MonthlyRewardSummary. The eligible usage amount for the usage period.

Returns:	The eligible_usage_amount of this MonthlyRewardSummary.
Return type:	float

ineligible_usage_amount¶

Gets the ineligible_usage_amount of this MonthlyRewardSummary. The ineligible usage amount for the usage period.

Returns:	The ineligible_usage_amount of this MonthlyRewardSummary.
Return type:	float

is_manual¶

Gets the is_manual of this MonthlyRewardSummary. The boolean parameter to indicate whether or not the available rewards are manually posted.

Returns:	The is_manual of this MonthlyRewardSummary.
Return type:	bool

redeemed_rewards¶

Gets the redeemed_rewards of this MonthlyRewardSummary. The number of rewards redeemed for a specific month.

Returns:	The redeemed_rewards of this MonthlyRewardSummary.
Return type:	float

time_rewards_earned¶

Gets the time_rewards_earned of this MonthlyRewardSummary. The date and time when rewards accrue.

Returns:	The time_rewards_earned of this MonthlyRewardSummary.
Return type:	datetime

time_rewards_expired¶

Gets the time_rewards_expired of this MonthlyRewardSummary. The date and time when rewards expire.

Returns:	The time_rewards_expired of this MonthlyRewardSummary.
Return type:	datetime

time_usage_ended¶

Gets the time_usage_ended of this MonthlyRewardSummary. The end date and time for the usage period.

Returns:	The time_usage_ended of this MonthlyRewardSummary.
Return type:	datetime

time_usage_started¶

Gets the time_usage_started of this MonthlyRewardSummary. The start date and time for the usage period.

Returns:	The time_usage_started of this MonthlyRewardSummary.
Return type:	datetime

usage_amount¶

Gets the usage_amount of this MonthlyRewardSummary. The usage amount for the usage period.

Returns:	The usage_amount of this MonthlyRewardSummary.
Return type:	float

usage_period_key¶

Gets the usage_period_key of this MonthlyRewardSummary. The usage period ID.

Returns:	The usage_period_key of this MonthlyRewardSummary.
Return type:	str