Package com.oracle.bmc.usageapi.model

Class UsageCarbonEmissionsReportQuery.Builder

java.lang.Object

com.oracle.bmc.usageapi.model.UsageCarbonEmissionsReportQuery.Builder

Enclosing class:

UsageCarbonEmissionsReportQuery

public static class UsageCarbonEmissionsReportQuery.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UsageCarbonEmissionsReportQuery	build()
UsageCarbonEmissionsReportQuery.Builder	compartmentDepth(Integer compartmentDepth)	The compartment depth level.
UsageCarbonEmissionsReportQuery.Builder	copy(UsageCarbonEmissionsReportQuery model)
UsageCarbonEmissionsReportQuery.Builder	dateRangeName(UsageCarbonEmissionsReportQuery.DateRangeName dateRangeName)	The user interface date range, for example, LAST_THREE_MONTHS.
UsageCarbonEmissionsReportQuery.Builder	emissionCalculationMethod(RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod emissionCalculationMethod)	Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED
UsageCarbonEmissionsReportQuery.Builder	emissionType(RequestUsageCarbonEmissionsDetails.EmissionType emissionType)	Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.
UsageCarbonEmissionsReportQuery.Builder	filter(Filter filter)
UsageCarbonEmissionsReportQuery.Builder	granularity(RequestUsageCarbonEmissionsDetails.Granularity granularity)	The carbon emission granularity.
UsageCarbonEmissionsReportQuery.Builder	groupBy(List<String> groupBy)	Specifies what to aggregate the result by.
UsageCarbonEmissionsReportQuery.Builder	groupByTag(List<Tag> groupByTag)	GroupBy a specific tagKey.
UsageCarbonEmissionsReportQuery.Builder	isAggregateByTime(Boolean isAggregateByTime)	Specifies whether aggregated by time.
UsageCarbonEmissionsReportQuery.Builder	tenantId(String tenantId)	Tenant ID.
UsageCarbonEmissionsReportQuery.Builder	timeUsageEnded(Date timeUsageEnded)	The usage end time.
UsageCarbonEmissionsReportQuery.Builder	timeUsageStarted(Date timeUsageStarted)	The usage start time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

tenantId

public UsageCarbonEmissionsReportQuery.Builder tenantId(String tenantId)

Tenant ID.

Parameters:

tenantId - the value to set

Returns:

this builder

timeUsageStarted

public UsageCarbonEmissionsReportQuery.Builder timeUsageStarted(Date timeUsageStarted)

The usage start time.

Parameters:

timeUsageStarted - the value to set

Returns:

this builder

timeUsageEnded

public UsageCarbonEmissionsReportQuery.Builder timeUsageEnded(Date timeUsageEnded)

The usage end time.

Parameters:

timeUsageEnded - the value to set

Returns:

this builder

emissionCalculationMethod

public UsageCarbonEmissionsReportQuery.Builder emissionCalculationMethod(RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod emissionCalculationMethod)

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

Parameters:

emissionCalculationMethod - the value to set

Returns:

this builder

emissionType

public UsageCarbonEmissionsReportQuery.Builder emissionType(RequestUsageCarbonEmissionsDetails.EmissionType emissionType)

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

Parameters:

emissionType - the value to set

Returns:

this builder

granularity

public UsageCarbonEmissionsReportQuery.Builder granularity(RequestUsageCarbonEmissionsDetails.Granularity granularity)

The carbon emission granularity.

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

Parameters:

granularity - the value to set

Returns:

this builder

isAggregateByTime

public UsageCarbonEmissionsReportQuery.Builder isAggregateByTime(Boolean isAggregateByTime)

Specifies whether aggregated by time.

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

Parameters:

isAggregateByTime - the value to set

Returns:

this builder

groupBy

public UsageCarbonEmissionsReportQuery.Builder groupBy(List<String> groupBy)

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”]

Parameters:

groupBy - the value to set

Returns:

this builder

groupByTag

public UsageCarbonEmissionsReportQuery.Builder groupByTag(List<Tag> groupByTag)

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”]}

Parameters:

groupByTag - the value to set

Returns:

this builder

compartmentDepth

public UsageCarbonEmissionsReportQuery.Builder compartmentDepth(Integer compartmentDepth)

The compartment depth level.

Parameters:

compartmentDepth - the value to set

Returns:

this builder

filter

public UsageCarbonEmissionsReportQuery.Builder filter(Filter filter)

dateRangeName

public UsageCarbonEmissionsReportQuery.Builder dateRangeName(UsageCarbonEmissionsReportQuery.DateRangeName dateRangeName)

The user interface date range, for example, LAST_THREE_MONTHS.

Overrides the timeUsageStarted and timeUsageEnded properties.

Parameters:

dateRangeName - the value to set

Returns:

this builder

build

public UsageCarbonEmissionsReportQuery build()

copy

public UsageCarbonEmissionsReportQuery.Builder copy(UsageCarbonEmissionsReportQuery model)