Package com.oracle.bmc.usageapi.model

Class RequestUsageCarbonEmissionsDetails.Builder

java.lang.Object

com.oracle.bmc.usageapi.model.RequestUsageCarbonEmissionsDetails.Builder

Enclosing class:

RequestUsageCarbonEmissionsDetails

public static class RequestUsageCarbonEmissionsDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RequestUsageCarbonEmissionsDetails	build()
RequestUsageCarbonEmissionsDetails.Builder	compartmentDepth(Integer compartmentDepth)	The compartment depth level.
RequestUsageCarbonEmissionsDetails.Builder	copy(RequestUsageCarbonEmissionsDetails model)
RequestUsageCarbonEmissionsDetails.Builder	emissionCalculationMethod(RequestUsageCarbonEmissionsDetails.EmissionCalculationMethod emissionCalculationMethod)	Specifies the method used for emission calculation, such as POWER_BASED or SPEND_BASED
RequestUsageCarbonEmissionsDetails.Builder	emissionType(RequestUsageCarbonEmissionsDetails.EmissionType emissionType)	Specifies the type of emission, such as MARKET_BASED or LOCATION_BASED.
RequestUsageCarbonEmissionsDetails.Builder	filter(Filter filter)
RequestUsageCarbonEmissionsDetails.Builder	granularity(RequestUsageCarbonEmissionsDetails.Granularity granularity)	The carbon emission granularity.
RequestUsageCarbonEmissionsDetails.Builder	groupBy(List<String> groupBy)	Aggregate the result by.
RequestUsageCarbonEmissionsDetails.Builder	groupByTag(List<Tag> groupByTag)	GroupBy a specific tagKey.
RequestUsageCarbonEmissionsDetails.Builder	isAggregateByTime(Boolean isAggregateByTime)	Specifies whether aggregated by time.
RequestUsageCarbonEmissionsDetails.Builder	tenantId(String tenantId)	Tenant ID.
RequestUsageCarbonEmissionsDetails.Builder	timeUsageEnded(Date timeUsageEnded)	The usage end time.
RequestUsageCarbonEmissionsDetails.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 RequestUsageCarbonEmissionsDetails.Builder tenantId(String tenantId)

Tenant ID.

Parameters:

tenantId - the value to set

Returns:

this builder

timeUsageStarted

public RequestUsageCarbonEmissionsDetails.Builder timeUsageStarted(Date timeUsageStarted)

The usage start time.

Parameters:

timeUsageStarted - the value to set

Returns:

this builder

timeUsageEnded

public RequestUsageCarbonEmissionsDetails.Builder timeUsageEnded(Date timeUsageEnded)

The usage end time.

Parameters:

timeUsageEnded - the value to set

Returns:

this builder

emissionCalculationMethod

public RequestUsageCarbonEmissionsDetails.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 RequestUsageCarbonEmissionsDetails.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 RequestUsageCarbonEmissionsDetails.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 RequestUsageCarbonEmissionsDetails.Builder isAggregateByTime(Boolean isAggregateByTime)

Specifies whether aggregated by time.

If isAggregateByTime is true, all carbon emissions usage over the query time period are summed.

Parameters:

isAggregateByTime - the value to set

Returns:

this builder

groupBy

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

Aggregate the result by.

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

Parameters:

groupBy - the value to set

Returns:

this builder

groupByTag

public RequestUsageCarbonEmissionsDetails.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 RequestUsageCarbonEmissionsDetails.Builder compartmentDepth(Integer compartmentDepth)

The compartment depth level.

Parameters:

compartmentDepth - the value to set

Returns:

this builder

filter

public RequestUsageCarbonEmissionsDetails.Builder filter(Filter filter)

build

public RequestUsageCarbonEmissionsDetails build()

copy

public RequestUsageCarbonEmissionsDetails.Builder copy(RequestUsageCarbonEmissionsDetails model)