Interface GetEstimatedCarbonEmissionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetEstimatedCarbonEmissionsRequest.Builder,GetEstimatedCarbonEmissionsRequest>, SdkBuilder<GetEstimatedCarbonEmissionsRequest.Builder,GetEstimatedCarbonEmissionsRequest>, SdkPojo, SdkRequest.Builder, SustainabilityRequest.Builder

Enclosing class:

GetEstimatedCarbonEmissionsRequest

@Mutable
@NotThreadSafe
public static interface GetEstimatedCarbonEmissionsRequest.Builder
extends SustainabilityRequest.Builder, SdkPojo, CopyableBuilder<GetEstimatedCarbonEmissionsRequest.Builder,GetEstimatedCarbonEmissionsRequest>

Method Summary

Modifier and Type	Method	Description
GetEstimatedCarbonEmissionsRequest.Builder	emissionsTypes(Collection<EmissionsType> emissionsTypes)	The emission types to include in the results.
GetEstimatedCarbonEmissionsRequest.Builder	emissionsTypes(EmissionsType... emissionsTypes)	The emission types to include in the results.
GetEstimatedCarbonEmissionsRequest.Builder	emissionsTypesWithStrings(String... emissionsTypes)	The emission types to include in the results.
GetEstimatedCarbonEmissionsRequest.Builder	emissionsTypesWithStrings(Collection<String> emissionsTypes)	The emission types to include in the results.
default GetEstimatedCarbonEmissionsRequest.Builder	filterBy(Consumer<FilterExpression.Builder> filterBy)	The criteria for filtering estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	filterBy(FilterExpression filterBy)	The criteria for filtering estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	granularity(String granularity)	The time granularity for the results.
GetEstimatedCarbonEmissionsRequest.Builder	granularity(TimeGranularity granularity)	The time granularity for the results.
default GetEstimatedCarbonEmissionsRequest.Builder	granularityConfiguration(Consumer<GranularityConfiguration.Builder> granularityConfiguration)	Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.
GetEstimatedCarbonEmissionsRequest.Builder	granularityConfiguration(GranularityConfiguration granularityConfiguration)	Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.
GetEstimatedCarbonEmissionsRequest.Builder	groupBy(Collection<Dimension> groupBy)	The dimensions available for grouping estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	groupBy(Dimension... groupBy)	The dimensions available for grouping estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	groupByWithStrings(String... groupBy)	The dimensions available for grouping estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	groupByWithStrings(Collection<String> groupBy)	The dimensions available for grouping estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
GetEstimatedCarbonEmissionsRequest.Builder	nextToken(String nextToken)	The pagination token specifying which page of results to return in the response.
GetEstimatedCarbonEmissionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetEstimatedCarbonEmissionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default GetEstimatedCarbonEmissionsRequest.Builder	timePeriod(Consumer<TimePeriod.Builder> timePeriod)	The date range for fetching estimated carbon emissions.
GetEstimatedCarbonEmissionsRequest.Builder	timePeriod(TimePeriod timePeriod)	The date range for fetching estimated carbon emissions.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.sustainability.model.SustainabilityRequest.Builder

build

Method Details

timePeriod

GetEstimatedCarbonEmissionsRequest.Builder timePeriod(TimePeriod timePeriod)

The date range for fetching estimated carbon emissions.

Parameters:

timePeriod - The date range for fetching estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

timePeriod

default GetEstimatedCarbonEmissionsRequest.Builder timePeriod(Consumer<TimePeriod.Builder> timePeriod)

The date range for fetching estimated carbon emissions.

This is a convenience method that creates an instance of the TimePeriod.Builder avoiding the need to create one manually via TimePeriod.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(TimePeriod).

Parameters:

timePeriod - a consumer that will call methods on TimePeriod.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• timePeriod(TimePeriod)

groupByWithStrings

GetEstimatedCarbonEmissionsRequest.Builder groupByWithStrings(Collection<String> groupBy)

The dimensions available for grouping estimated carbon emissions.

Parameters:

groupBy - The dimensions available for grouping estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupByWithStrings

GetEstimatedCarbonEmissionsRequest.Builder groupByWithStrings(String... groupBy)

The dimensions available for grouping estimated carbon emissions.

Parameters:

groupBy - The dimensions available for grouping estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

GetEstimatedCarbonEmissionsRequest.Builder groupBy(Collection<Dimension> groupBy)

The dimensions available for grouping estimated carbon emissions.

Parameters:

groupBy - The dimensions available for grouping estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

groupBy

GetEstimatedCarbonEmissionsRequest.Builder groupBy(Dimension... groupBy)

The dimensions available for grouping estimated carbon emissions.

Parameters:

groupBy - The dimensions available for grouping estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

filterBy

GetEstimatedCarbonEmissionsRequest.Builder filterBy(FilterExpression filterBy)

The criteria for filtering estimated carbon emissions.

Parameters:

filterBy - The criteria for filtering estimated carbon emissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

filterBy

default GetEstimatedCarbonEmissionsRequest.Builder filterBy(Consumer<FilterExpression.Builder> filterBy)

The criteria for filtering estimated carbon emissions.

This is a convenience method that creates an instance of the FilterExpression.Builder avoiding the need to create one manually via FilterExpression.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterBy(FilterExpression).

Parameters:

filterBy - a consumer that will call methods on FilterExpression.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filterBy(FilterExpression)

emissionsTypesWithStrings

GetEstimatedCarbonEmissionsRequest.Builder emissionsTypesWithStrings(Collection<String> emissionsTypes)

The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Parameters:

emissionsTypes - The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Returns:

Returns a reference to this object so that method calls can be chained together.

emissionsTypesWithStrings

GetEstimatedCarbonEmissionsRequest.Builder emissionsTypesWithStrings(String... emissionsTypes)

The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Parameters:

emissionsTypes - The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Returns:

Returns a reference to this object so that method calls can be chained together.

emissionsTypes

GetEstimatedCarbonEmissionsRequest.Builder emissionsTypes(Collection<EmissionsType> emissionsTypes)

The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Parameters:

emissionsTypes - The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Returns:

Returns a reference to this object so that method calls can be chained together.

emissionsTypes

GetEstimatedCarbonEmissionsRequest.Builder emissionsTypes(EmissionsType... emissionsTypes)

The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Parameters:

emissionsTypes - The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

Returns:

Returns a reference to this object so that method calls can be chained together.

granularity

GetEstimatedCarbonEmissionsRequest.Builder granularity(String granularity)

The time granularity for the results. If absent, uses MONTHLY time granularity.

Parameters:

granularity - The time granularity for the results. If absent, uses MONTHLY time granularity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TimeGranularity
• TimeGranularity

granularity

GetEstimatedCarbonEmissionsRequest.Builder granularity(TimeGranularity granularity)

The time granularity for the results. If absent, uses MONTHLY time granularity.

Parameters:

granularity - The time granularity for the results. If absent, uses MONTHLY time granularity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• TimeGranularity
• TimeGranularity

granularityConfiguration

GetEstimatedCarbonEmissionsRequest.Builder granularityConfiguration(GranularityConfiguration granularityConfiguration)

Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.

Parameters:

granularityConfiguration - Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.

Returns:

Returns a reference to this object so that method calls can be chained together.

granularityConfiguration

default GetEstimatedCarbonEmissionsRequest.Builder granularityConfiguration(Consumer<GranularityConfiguration.Builder> granularityConfiguration)

Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.

This is a convenience method that creates an instance of the GranularityConfiguration.Builder avoiding the need to create one manually via GranularityConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to granularityConfiguration(GranularityConfiguration).

Parameters:

granularityConfiguration - a consumer that will call methods on GranularityConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• granularityConfiguration(GranularityConfiguration)

maxResults

GetEstimatedCarbonEmissionsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call. Default is 40.

Parameters:

maxResults - The maximum number of results to return in a single call. Default is 40.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

GetEstimatedCarbonEmissionsRequest.Builder nextToken(String nextToken)

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Parameters:

nextToken - The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetEstimatedCarbonEmissionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetEstimatedCarbonEmissionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.