Interface TopBottomFilter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<TopBottomFilter.Builder,TopBottomFilter>,SdkBuilder<TopBottomFilter.Builder,TopBottomFilter>,SdkPojo
- Enclosing class:
- TopBottomFilter
@Mutable @NotThreadSafe public static interface TopBottomFilter.Builder extends SdkPojo, CopyableBuilder<TopBottomFilter.Builder,TopBottomFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TopBottomFilter.BuilderaggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations)The aggregation and sort configuration of the top bottom filter.TopBottomFilter.BuilderaggregationSortConfigurations(Consumer<AggregationSortConfiguration.Builder>... aggregationSortConfigurations)The aggregation and sort configuration of the top bottom filter.TopBottomFilter.BuilderaggregationSortConfigurations(AggregationSortConfiguration... aggregationSortConfigurations)The aggregation and sort configuration of the top bottom filter.default TopBottomFilter.Buildercolumn(Consumer<ColumnIdentifier.Builder> column)The column that the filter is applied to.TopBottomFilter.Buildercolumn(ColumnIdentifier column)The column that the filter is applied to.default TopBottomFilter.BuilderdefaultFilterControlConfiguration(Consumer<DefaultFilterControlConfiguration.Builder> defaultFilterControlConfiguration)The default configurations for the associated controls.TopBottomFilter.BuilderdefaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)The default configurations for the associated controls.TopBottomFilter.BuilderfilterId(String filterId)An identifier that uniquely identifies a filter within a dashboard, analysis, or template.TopBottomFilter.Builderlimit(Integer limit)The number of items to include in the top bottom filter results.TopBottomFilter.BuilderparameterName(String parameterName)The parameter whose value should be used for the filter value.TopBottomFilter.BuildertimeGranularity(String timeGranularity)The level of time precision that is used to aggregateDateTimevalues.TopBottomFilter.BuildertimeGranularity(TimeGranularity timeGranularity)The level of time precision that is used to aggregateDateTimevalues.-
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
-
-
-
-
Method Detail
-
filterId
TopBottomFilter.Builder filterId(String filterId)
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
- Parameters:
filterId- An identifier that uniquely identifies a filter within a dashboard, analysis, or template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
column
TopBottomFilter.Builder column(ColumnIdentifier column)
The column that the filter is applied to.
- Parameters:
column- The column that the filter is applied to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
column
default TopBottomFilter.Builder column(Consumer<ColumnIdentifier.Builder> column)
The column that the filter is applied to.
This is a convenience method that creates an instance of theColumnIdentifier.Builderavoiding the need to create one manually viaColumnIdentifier.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocolumn(ColumnIdentifier).- Parameters:
column- a consumer that will call methods onColumnIdentifier.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
column(ColumnIdentifier)
-
limit
TopBottomFilter.Builder limit(Integer limit)
The number of items to include in the top bottom filter results.
- Parameters:
limit- The number of items to include in the top bottom filter results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationSortConfigurations
TopBottomFilter.Builder aggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations)
The aggregation and sort configuration of the top bottom filter.
- Parameters:
aggregationSortConfigurations- The aggregation and sort configuration of the top bottom filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationSortConfigurations
TopBottomFilter.Builder aggregationSortConfigurations(AggregationSortConfiguration... aggregationSortConfigurations)
The aggregation and sort configuration of the top bottom filter.
- Parameters:
aggregationSortConfigurations- The aggregation and sort configuration of the top bottom filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
aggregationSortConfigurations
TopBottomFilter.Builder aggregationSortConfigurations(Consumer<AggregationSortConfiguration.Builder>... aggregationSortConfigurations)
The aggregation and sort configuration of the top bottom filter.
This is a convenience method that creates an instance of theAggregationSortConfiguration.Builderavoiding the need to create one manually viaAggregationSortConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#aggregationSortConfigurations(List.) - Parameters:
aggregationSortConfigurations- a consumer that will call methods onAggregationSortConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#aggregationSortConfigurations(java.util.Collection)
-
timeGranularity
TopBottomFilter.Builder timeGranularity(String timeGranularity)
The level of time precision that is used to aggregate
DateTimevalues.- Parameters:
timeGranularity- The level of time precision that is used to aggregateDateTimevalues.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TimeGranularity,TimeGranularity
-
timeGranularity
TopBottomFilter.Builder timeGranularity(TimeGranularity timeGranularity)
The level of time precision that is used to aggregate
DateTimevalues.- Parameters:
timeGranularity- The level of time precision that is used to aggregateDateTimevalues.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
TimeGranularity,TimeGranularity
-
parameterName
TopBottomFilter.Builder parameterName(String parameterName)
The parameter whose value should be used for the filter value.
- Parameters:
parameterName- The parameter whose value should be used for the filter value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultFilterControlConfiguration
TopBottomFilter.Builder defaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
- Parameters:
defaultFilterControlConfiguration- The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultFilterControlConfiguration
default TopBottomFilter.Builder defaultFilterControlConfiguration(Consumer<DefaultFilterControlConfiguration.Builder> defaultFilterControlConfiguration)
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
This is a convenience method that creates an instance of theDefaultFilterControlConfiguration.Builderavoiding the need to create one manually viaDefaultFilterControlConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todefaultFilterControlConfiguration(DefaultFilterControlConfiguration).- Parameters:
defaultFilterControlConfiguration- a consumer that will call methods onDefaultFilterControlConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
defaultFilterControlConfiguration(DefaultFilterControlConfiguration)
-
-