Interface GetEstimatedCarbonEmissionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<GetEstimatedCarbonEmissionsRequest.Builder,,GetEstimatedCarbonEmissionsRequest> SdkBuilder<GetEstimatedCarbonEmissionsRequest.Builder,,GetEstimatedCarbonEmissionsRequest> SdkPojo,SdkRequest.Builder,SustainabilityRequest.Builder
- Enclosing class:
GetEstimatedCarbonEmissionsRequest
-
Method Summary
Modifier and TypeMethodDescriptionemissionsTypes(Collection<EmissionsType> emissionsTypes) The emission types to include in the results.emissionsTypes(EmissionsType... emissionsTypes) The emission types to include in the results.emissionsTypesWithStrings(String... emissionsTypes) The emission types to include in the results.emissionsTypesWithStrings(Collection<String> emissionsTypes) The emission types to include in the results.filterBy(Consumer<FilterExpression.Builder> filterBy) The criteria for filtering estimated carbon emissions.filterBy(FilterExpression filterBy) The criteria for filtering estimated carbon emissions.granularity(String granularity) The time granularity for the results.granularity(TimeGranularity granularity) The time granularity for the results.granularityConfiguration(Consumer<GranularityConfiguration.Builder> granularityConfiguration) Configuration for fiscal year calculations when usingYEARLY_FISCALorQUARTERLY_FISCALgranularity.granularityConfiguration(GranularityConfiguration granularityConfiguration) Configuration for fiscal year calculations when usingYEARLY_FISCALorQUARTERLY_FISCALgranularity.groupBy(Collection<Dimension> groupBy) The dimensions available for grouping estimated carbon emissions.The dimensions available for grouping estimated carbon emissions.groupByWithStrings(String... groupBy) The dimensions available for grouping estimated carbon emissions.groupByWithStrings(Collection<String> groupBy) The dimensions available for grouping estimated carbon emissions.maxResults(Integer maxResults) The maximum number of results to return in a single call.The pagination token specifying which page of results to return in the response.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.timePeriod(Consumer<TimePeriod.Builder> timePeriod) The date range for fetching estimated carbon emissions.timePeriod(TimePeriod timePeriod) The date range for fetching estimated carbon emissions.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFieldsMethods inherited from interface software.amazon.awssdk.services.sustainability.model.SustainabilityRequest.Builder
build
-
Method Details
-
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 theTimePeriod.Builderavoiding the need to create one manually viaTimePeriod.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimePeriod(TimePeriod).- Parameters:
timePeriod- a consumer that will call methods onTimePeriod.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
groupByWithStrings
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
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
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
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
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 theFilterExpression.Builderavoiding the need to create one manually viaFilterExpression.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilterBy(FilterExpression).- Parameters:
filterBy- a consumer that will call methods onFilterExpression.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
emissionsTypesWithStrings
GetEstimatedCarbonEmissionsRequest.Builder emissionsTypesWithStrings(Collection<String> emissionsTypes) The emission types to include in the results. If absent, returns
TOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Parameters:
emissionsTypes- The emission types to include in the results. If absent, returnsTOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emissionsTypesWithStrings
The emission types to include in the results. If absent, returns
TOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Parameters:
emissionsTypes- The emission types to include in the results. If absent, returnsTOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emissionsTypes
The emission types to include in the results. If absent, returns
TOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Parameters:
emissionsTypes- The emission types to include in the results. If absent, returnsTOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
emissionsTypes
The emission types to include in the results. If absent, returns
TOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Parameters:
emissionsTypes- The emission types to include in the results. If absent, returnsTOTAL_LBM_CARBON_EMISSIONSandTOTAL_MBM_CARBON_EMISSIONSemissions types.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
granularity
The time granularity for the results. If absent, uses
MONTHLYtime granularity.- Parameters:
granularity- The time granularity for the results. If absent, usesMONTHLYtime granularity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularity
The time granularity for the results. If absent, uses
MONTHLYtime granularity.- Parameters:
granularity- The time granularity for the results. If absent, usesMONTHLYtime granularity.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
granularityConfiguration
GetEstimatedCarbonEmissionsRequest.Builder granularityConfiguration(GranularityConfiguration granularityConfiguration) Configuration for fiscal year calculations when using
YEARLY_FISCALorQUARTERLY_FISCALgranularity.- Parameters:
granularityConfiguration- Configuration for fiscal year calculations when usingYEARLY_FISCALorQUARTERLY_FISCALgranularity.- 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
This is a convenience method that creates an instance of theYEARLY_FISCALorQUARTERLY_FISCALgranularity.GranularityConfiguration.Builderavoiding the need to create one manually viaGranularityConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed togranularityConfiguration(GranularityConfiguration).- Parameters:
granularityConfiguration- a consumer that will call methods onGranularityConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-