Package com.oracle.bmc.usageapi.model

Class UsageCarbonEmissionsReportQuery

java.lang.Object

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

com.oracle.bmc.usageapi.model.UsageCarbonEmissionsReportQuery

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

The request of the generated carbon emissions usage report.
Note: Objects should always be created or deserialized using the UsageCarbonEmissionsReportQuery.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 UsageCarbonEmissionsReportQuery.Builder, which maintain a set of all explicitly set fields called UsageCarbonEmissionsReportQuery.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	UsageCarbonEmissionsReportQuery.Builder
static class	UsageCarbonEmissionsReportQuery.DateRangeName	The user interface date range, for example, LAST_THREE_MONTHS.

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

UsageCarbonEmissionsReportQuery(String tenantId, Date timeUsageStarted, Date timeUsageEnded, RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod emissionCalculationMethod, RequestUsageCarbonEmissionsDetails.EmissionType emissionType, RequestUsageCarbonEmissionsDetails.Granularity granularity, Boolean isAggregateByTime, List<String> groupBy, List<Tag> groupByTag, Integer compartmentDepth, Filter filter, UsageCarbonEmissionsReportQuery.DateRangeName dateRangeName)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static UsageCarbonEmissionsReportQuery.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getCompartmentDepth()	The compartment depth level.
UsageCarbonEmissionsReportQuery.DateRangeName	getDateRangeName()	The user interface date range, for example, LAST_THREE_MONTHS.
RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod	getEmissionCalculationMethod()	Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED
RequestUsageCarbonEmissionsDetails.EmissionType	getEmissionType()	Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.
Filter	getFilter()
RequestUsageCarbonEmissionsDetails.Granularity	getGranularity()	The carbon emission granularity.
List<String>	getGroupBy()	Specifies what to aggregate the result by.
List<Tag>	getGroupByTag()	GroupBy a specific tagKey.
Boolean	getIsAggregateByTime()	Specifies whether aggregated by time.
String	getTenantId()	Tenant ID.
Date	getTimeUsageEnded()	The usage end time.
Date	getTimeUsageStarted()	The usage start time.
int	hashCode()
UsageCarbonEmissionsReportQuery.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

UsageCarbonEmissionsReportQuery

@Deprecated
@ConstructorProperties({"tenantId","timeUsageStarted","timeUsageEnded","emissionCalculationMethod","emissionType","granularity","isAggregateByTime","groupBy","groupByTag","compartmentDepth","filter","dateRangeName"})
public UsageCarbonEmissionsReportQuery(String tenantId,
                                       Date timeUsageStarted,
                                       Date timeUsageEnded,
                                       RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod emissionCalculationMethod,
                                       RequestUsageCarbonEmissionsDetails.EmissionType emissionType,
                                       RequestUsageCarbonEmissionsDetails.Granularity granularity,
                                       Boolean isAggregateByTime,
                                       List<String> groupBy,
                                       List<Tag> groupByTag,
                                       Integer compartmentDepth,
                                       Filter filter,
                                       UsageCarbonEmissionsReportQuery.DateRangeName dateRangeName)

Deprecated.

Method Detail

builder

public static UsageCarbonEmissionsReportQuery.Builder builder()

Create a new builder.

toBuilder

public UsageCarbonEmissionsReportQuery.Builder toBuilder()

getTenantId

public String getTenantId()

Tenant ID.

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

getEmissionCalculationMethod

public RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod getEmissionCalculationMethod()

Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED

Returns:

the value

getEmissionType

public RequestUsageCarbonEmissionsDetails.EmissionType getEmissionType()

Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.

Returns:

the value

getGranularity

public RequestUsageCarbonEmissionsDetails.Granularity getGranularity()

The carbon emission granularity.

DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation.

Returns:

the value

getIsAggregateByTime

public Boolean getIsAggregateByTime()

Specifies whether aggregated by time.

If isAggregateByTime is true, all usage or costs over the query time period are summed.

Returns:

the value

getGroupBy

public List<String> getGroupBy()

Specifies what to aggregate the result by.

For example: [“tagNamespace”, “tagKey”, “tagValue”, “service”, “skuName”, “skuPartNumber”, “unit”, “compartmentName”, “compartmentPath”, “compartmentId”, “platform”, “region”, “logicalAd”, “resourceId”, “tenantId”, “tenantName”]

Returns:

the value

getGroupByTag

public List<Tag> getGroupByTag()

GroupBy a specific tagKey.

Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example: {@code [{“namespace”:“oracle”, “key”:“createdBy”]}

Returns:

the value

getCompartmentDepth

public Integer getCompartmentDepth()

The compartment depth level.

Returns:

the value

getFilter

public Filter getFilter()

getDateRangeName

public UsageCarbonEmissionsReportQuery.DateRangeName getDateRangeName()

The user interface date range, for example, LAST_THREE_MONTHS.

Overrides the timeUsageStarted and timeUsageEnded properties.

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