Package com.oracle.bmc.usageapi.model

Class UsageCarbonEmissionSummary

java.lang.Object

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

com.oracle.bmc.usageapi.model.UsageCarbonEmissionSummary

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

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

UsageCarbonEmissionSummary(String tenantId, String tenantName, String compartmentId, String compartmentPath, String compartmentName, String service, String resourceName, String resourceId, String region, String ad, String skuPartNumber, String skuName, String platform, Date timeUsageStarted, Date timeUsageEnded, Double computedCarbonEmission, String emissionCalculationMethod, RequestUsageCarbonEmissionsDetails.EmissionType emissionType, String subscriptionId, List<Tag> tags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static UsageCarbonEmissionSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAd()	The availability domain of the usage.
String	getCompartmentId()	The compartment OCID.
String	getCompartmentName()	The compartment name.
String	getCompartmentPath()	The compartment path, starting from root.
Double	getComputedCarbonEmission()	The carbon emission usage in MTCO2 units.
String	getEmissionCalculationMethod()	Specifies the approach for calculating carbon emissions, supports both SPEND_BASED (based on expenditure data) and POWER_BASED (based on power consumption, newly introduced in the metering pipeline)
RequestUsageCarbonEmissionsDetails.EmissionType	getEmissionType()	The emission type, such as MARKET_BASED or LOCATION_BASED.
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	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.
int	hashCode()
UsageCarbonEmissionSummary.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

UsageCarbonEmissionSummary

@Deprecated
@ConstructorProperties({"tenantId","tenantName","compartmentId","compartmentPath","compartmentName","service","resourceName","resourceId","region","ad","skuPartNumber","skuName","platform","timeUsageStarted","timeUsageEnded","computedCarbonEmission","emissionCalculationMethod","emissionType","subscriptionId","tags"})
public UsageCarbonEmissionSummary(String tenantId,
                                  String tenantName,
                                  String compartmentId,
                                  String compartmentPath,
                                  String compartmentName,
                                  String service,
                                  String resourceName,
                                  String resourceId,
                                  String region,
                                  String ad,
                                  String skuPartNumber,
                                  String skuName,
                                  String platform,
                                  Date timeUsageStarted,
                                  Date timeUsageEnded,
                                  Double computedCarbonEmission,
                                  String emissionCalculationMethod,
                                  RequestUsageCarbonEmissionsDetails.EmissionType emissionType,
                                  String subscriptionId,
                                  List<Tag> tags)

Deprecated.

Method Detail

builder

public static UsageCarbonEmissionSummary.Builder builder()

Create a new builder.

toBuilder

public UsageCarbonEmissionSummary.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

getSkuPartNumber

public String getSkuPartNumber()

The SKU part number.

Returns:

the value

getSkuName

public String getSkuName()

The SKU friendly name.

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

getComputedCarbonEmission

public Double getComputedCarbonEmission()

The carbon emission usage in MTCO2 units.

Returns:

the value

getEmissionCalculationMethod

public String getEmissionCalculationMethod()

Specifies the approach for calculating carbon emissions, supports both SPEND_BASED (based on expenditure data) and POWER_BASED (based on power consumption, newly introduced in the metering pipeline)

Returns:

the value

getEmissionType

public RequestUsageCarbonEmissionsDetails.EmissionType getEmissionType()

The emission type, such as MARKET_BASED or LOCATION_BASED.

Returns:

the value

getSubscriptionId

public String getSubscriptionId()

The subscription ID.

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