UsageCarbonEmissionSummary¶

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

Bases: object

The usage carbon emission store result.

Methods

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

Attributes

`ad`	Gets the ad of this UsageCarbonEmissionSummary.
`compartment_id`	Gets the compartment_id of this UsageCarbonEmissionSummary.
`compartment_name`	Gets the compartment_name of this UsageCarbonEmissionSummary.
`compartment_path`	Gets the compartment_path of this UsageCarbonEmissionSummary.
`computed_carbon_emission`	[Required] Gets the computed_carbon_emission of this UsageCarbonEmissionSummary.
`emission_calculation_method`	[Required] Gets the emission_calculation_method of this UsageCarbonEmissionSummary.
`platform`	Gets the platform of this UsageCarbonEmissionSummary.
`region`	Gets the region of this UsageCarbonEmissionSummary.
`resource_id`	Gets the resource_id of this UsageCarbonEmissionSummary.
`resource_name`	Gets the resource_name of this UsageCarbonEmissionSummary.
`service`	Gets the service of this UsageCarbonEmissionSummary.
`sku_name`	Gets the sku_name of this UsageCarbonEmissionSummary.
`sku_part_number`	Gets the sku_part_number of this UsageCarbonEmissionSummary.
`subscription_id`	Gets the subscription_id of this UsageCarbonEmissionSummary.
`tags`	Gets the tags of this UsageCarbonEmissionSummary.
`tenant_id`	Gets the tenant_id of this UsageCarbonEmissionSummary.
`tenant_name`	Gets the tenant_name of this UsageCarbonEmissionSummary.
`time_usage_ended`	[Required] Gets the time_usage_ended of this UsageCarbonEmissionSummary.
`time_usage_started`	[Required] Gets the time_usage_started of this UsageCarbonEmissionSummary.

__init__(**kwargs)¶

Initializes a new UsageCarbonEmissionSummary 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 UsageCarbonEmissionSummary.
tenant_name (str) – The value to assign to the tenant_name property of this UsageCarbonEmissionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this UsageCarbonEmissionSummary.
compartment_path (str) – The value to assign to the compartment_path property of this UsageCarbonEmissionSummary.
compartment_name (str) – The value to assign to the compartment_name property of this UsageCarbonEmissionSummary.
service (str) – The value to assign to the service property of this UsageCarbonEmissionSummary.
resource_name (str) – The value to assign to the resource_name property of this UsageCarbonEmissionSummary.
resource_id (str) – The value to assign to the resource_id property of this UsageCarbonEmissionSummary.
region (str) – The value to assign to the region property of this UsageCarbonEmissionSummary.
ad (str) – The value to assign to the ad property of this UsageCarbonEmissionSummary.
sku_part_number (str) – The value to assign to the sku_part_number property of this UsageCarbonEmissionSummary.
sku_name (str) – The value to assign to the sku_name property of this UsageCarbonEmissionSummary.
platform (str) – The value to assign to the platform property of this UsageCarbonEmissionSummary.
time_usage_started (datetime) – The value to assign to the time_usage_started property of this UsageCarbonEmissionSummary.
time_usage_ended (datetime) – The value to assign to the time_usage_ended property of this UsageCarbonEmissionSummary.
computed_carbon_emission (float) – The value to assign to the computed_carbon_emission property of this UsageCarbonEmissionSummary.
emission_calculation_method (str) – The value to assign to the emission_calculation_method property of this UsageCarbonEmissionSummary.
subscription_id (str) – The value to assign to the subscription_id property of this UsageCarbonEmissionSummary.
tags (list[oci.usage_api.models.Tag]) – The value to assign to the tags property of this UsageCarbonEmissionSummary.

ad¶

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

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

compartment_id¶

Gets the compartment_id of this UsageCarbonEmissionSummary. The compartment OCID.

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

compartment_name¶

Gets the compartment_name of this UsageCarbonEmissionSummary. The compartment name.

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

compartment_path¶

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

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

computed_carbon_emission¶

[Required] Gets the computed_carbon_emission of this UsageCarbonEmissionSummary. The carbon emission in MTCO2 unit.

Returns:	The computed_carbon_emission of this UsageCarbonEmissionSummary.
Return type:	float

emission_calculation_method¶

[Required] Gets the emission_calculation_method of this UsageCarbonEmissionSummary. The method used to calculate carbon emission.

Returns:	The emission_calculation_method of this UsageCarbonEmissionSummary.
Return type:	str

platform¶

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

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

region¶

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

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

resource_id¶

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

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

resource_name¶

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

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

service¶

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

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

sku_name¶

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

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

sku_part_number¶

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

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

subscription_id¶

Gets the subscription_id of this UsageCarbonEmissionSummary. The subscription ID.

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

tags¶

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

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

tenant_id¶

Gets the tenant_id of this UsageCarbonEmissionSummary. The tenancy OCID.

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

tenant_name¶

Gets the tenant_name of this UsageCarbonEmissionSummary. The tenancy name.

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

time_usage_ended¶

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

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

time_usage_started¶

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

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