UsageSummary¶

class oci.usage_api.models.UsageSummary(**kwargs)¶

Bases: object

The usage store result.

Methods

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

Attributes

`ad`	Gets the ad of this UsageSummary.
`attributed_cost`	Gets the attributed_cost of this UsageSummary.
`attributed_usage`	Gets the attributed_usage of this UsageSummary.
`compartment_id`	Gets the compartment_id of this UsageSummary.
`compartment_name`	Gets the compartment_name of this UsageSummary.
`compartment_path`	Gets the compartment_path of this UsageSummary.
`computed_amount`	Gets the computed_amount of this UsageSummary.
`computed_quantity`	Gets the computed_quantity of this UsageSummary.
`currency`	Gets the currency of this UsageSummary.
`discount`	Gets the discount of this UsageSummary.
`is_forecast`	Gets the is_forecast of this UsageSummary.
`list_rate`	Gets the list_rate of this UsageSummary.
`overage`	Gets the overage of this UsageSummary.
`overages_flag`	Gets the overages_flag of this UsageSummary.
`platform`	Gets the platform of this UsageSummary.
`region`	Gets the region of this UsageSummary.
`resource_id`	Gets the resource_id of this UsageSummary.
`resource_name`	Gets the resource_name of this UsageSummary.
`service`	Gets the service of this UsageSummary.
`shape`	Gets the shape of this UsageSummary.
`sku_name`	Gets the sku_name of this UsageSummary.
`sku_part_number`	Gets the sku_part_number of this UsageSummary.
`subscription_id`	Gets the subscription_id of this UsageSummary.
`tags`	Gets the tags of this UsageSummary.
`tenant_id`	Gets the tenant_id of this UsageSummary.
`tenant_name`	Gets the tenant_name of this UsageSummary.
`time_usage_ended`	[Required] Gets the time_usage_ended of this UsageSummary.
`time_usage_started`	[Required] Gets the time_usage_started of this UsageSummary.
`unit`	Gets the unit of this UsageSummary.
`unit_price`	Gets the unit_price of this UsageSummary.
`weight`	Gets the weight of this UsageSummary.

__init__(**kwargs)¶

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

Parameters:

tenant_id (str) – The value to assign to the tenant_id property of this UsageSummary.
tenant_name (str) – The value to assign to the tenant_name property of this UsageSummary.
compartment_id (str) – The value to assign to the compartment_id property of this UsageSummary.
compartment_path (str) – The value to assign to the compartment_path property of this UsageSummary.
compartment_name (str) – The value to assign to the compartment_name property of this UsageSummary.
service (str) – The value to assign to the service property of this UsageSummary.
resource_name (str) – The value to assign to the resource_name property of this UsageSummary.
resource_id (str) – The value to assign to the resource_id property of this UsageSummary.
region (str) – The value to assign to the region property of this UsageSummary.
ad (str) – The value to assign to the ad property of this UsageSummary.
weight (float) – The value to assign to the weight property of this UsageSummary.
shape (str) – The value to assign to the shape property of this UsageSummary.
sku_part_number (str) – The value to assign to the sku_part_number property of this UsageSummary.
sku_name (str) – The value to assign to the sku_name property of this UsageSummary.
unit (str) – The value to assign to the unit property of this UsageSummary.
discount (float) – The value to assign to the discount property of this UsageSummary.
list_rate (float) – The value to assign to the list_rate property of this UsageSummary.
platform (str) – The value to assign to the platform property of this UsageSummary.
time_usage_started (datetime) – The value to assign to the time_usage_started property of this UsageSummary.
time_usage_ended (datetime) – The value to assign to the time_usage_ended property of this UsageSummary.
computed_amount (float) – The value to assign to the computed_amount property of this UsageSummary.
computed_quantity (float) – The value to assign to the computed_quantity property of this UsageSummary.
attributed_cost (str) – The value to assign to the attributed_cost property of this UsageSummary.
attributed_usage (str) – The value to assign to the attributed_usage property of this UsageSummary.
overages_flag (str) – The value to assign to the overages_flag property of this UsageSummary.
unit_price (float) – The value to assign to the unit_price property of this UsageSummary.
currency (str) – The value to assign to the currency property of this UsageSummary.
subscription_id (str) – The value to assign to the subscription_id property of this UsageSummary.
overage (str) – The value to assign to the overage property of this UsageSummary.
is_forecast (bool) – The value to assign to the is_forecast property of this UsageSummary.
tags (list[oci.usage_api.models.Tag]) – The value to assign to the tags property of this UsageSummary.

ad¶

Gets the ad of this UsageSummary. The availability domain of the usage.

Returns:	The ad of this UsageSummary.
Return type:	str

attributed_cost¶

Gets the attributed_cost of this UsageSummary. The attributed cost with a max value of 9999999999.999999999999 and a minimum value of 0.

Returns:	The attributed_cost of this UsageSummary.
Return type:	str

attributed_usage¶

Gets the attributed_usage of this UsageSummary. The attributed usage with a max value of 9999999999.999999999999 and a minimum value of 0.

Returns:	The attributed_usage of this UsageSummary.
Return type:	str

compartment_id¶

Gets the compartment_id of this UsageSummary. The compartment OCID.

Returns:	The compartment_id of this UsageSummary.
Return type:	str

compartment_name¶

Gets the compartment_name of this UsageSummary. The compartment name.

Returns:	The compartment_name of this UsageSummary.
Return type:	str

compartment_path¶

Gets the compartment_path of this UsageSummary. The compartment path, starting from root.

Returns:	The compartment_path of this UsageSummary.
Return type:	str

computed_amount¶

Gets the computed_amount of this UsageSummary. The computed cost.

Returns:	The computed_amount of this UsageSummary.
Return type:	float

computed_quantity¶

Gets the computed_quantity of this UsageSummary. The usage number.

Returns:	The computed_quantity of this UsageSummary.
Return type:	float

currency¶

Gets the currency of this UsageSummary. The price currency.

Returns:	The currency of this UsageSummary.
Return type:	str

discount¶

Gets the discount of this UsageSummary. The discretionary discount applied to the SKU.

Returns:	The discount of this UsageSummary.
Return type:	float

is_forecast¶

Gets the is_forecast of this UsageSummary. The forecasted data.

Returns:	The is_forecast of this UsageSummary.
Return type:	bool

list_rate¶

Gets the list_rate of this UsageSummary. The SKU list rate (not discount).

Returns:	The list_rate of this UsageSummary.
Return type:	float

overage¶

Gets the overage of this UsageSummary. The overage usage.

Returns:	The overage of this UsageSummary.
Return type:	str

overages_flag¶

Gets the overages_flag of this UsageSummary. The SPM OverageFlag.

Returns:	The overages_flag of this UsageSummary.
Return type:	str

platform¶

Gets the platform of this UsageSummary. Platform for the cost.

Returns:	The platform of this UsageSummary.
Return type:	str

region¶

Gets the region of this UsageSummary. The region of the usage.

Returns:	The region of this UsageSummary.
Return type:	str

resource_id¶

Gets the resource_id of this UsageSummary. The resource OCID that is incurring the cost.

Returns:	The resource_id of this UsageSummary.
Return type:	str

resource_name¶

Gets the resource_name of this UsageSummary. The resource name that is incurring the cost.

Returns:	The resource_name of this UsageSummary.
Return type:	str

service¶

Gets the service of this UsageSummary. The service name that is incurring the cost.

Returns:	The service of this UsageSummary.
Return type:	str

shape¶

Gets the shape of this UsageSummary. The resource shape.

Returns:	The shape of this UsageSummary.
Return type:	str

sku_name¶

Gets the sku_name of this UsageSummary. The SKU friendly name.

Returns:	The sku_name of this UsageSummary.
Return type:	str

sku_part_number¶

Gets the sku_part_number of this UsageSummary. The SKU part number.

Returns:	The sku_part_number of this UsageSummary.
Return type:	str

subscription_id¶

Gets the subscription_id of this UsageSummary. The subscription ID.

Returns:	The subscription_id of this UsageSummary.
Return type:	str

tags¶

Gets the tags of this UsageSummary. For grouping, a tag definition. For filtering, a definition and key.

Returns:	The tags of this UsageSummary.
Return type:	list[oci.usage_api.models.Tag]

tenant_id¶

Gets the tenant_id of this UsageSummary. The tenancy OCID.

Returns:	The tenant_id of this UsageSummary.
Return type:	str

tenant_name¶

Gets the tenant_name of this UsageSummary. The tenancy name.

Returns:	The tenant_name of this UsageSummary.
Return type:	str

time_usage_ended¶

[Required] Gets the time_usage_ended of this UsageSummary. The usage end time.

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

time_usage_started¶

[Required] Gets the time_usage_started of this UsageSummary. The usage start time.

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

unit¶

Gets the unit of this UsageSummary. The usage unit.

Returns:	The unit of this UsageSummary.
Return type:	str

unit_price¶

Gets the unit_price of this UsageSummary. The price per unit.

Returns:	The unit_price of this UsageSummary.
Return type:	float

weight¶

Gets the weight of this UsageSummary. The resource size being metered.

Returns:	The weight of this UsageSummary.
Return type:	float