Package software.amazon.awssdk.services.quicksight.model

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

Modifier and Type	Method	Description
TopBottomFilter.Builder	aggregationSortConfigurations(Collection<AggregationSortConfiguration> aggregationSortConfigurations)	The aggregation and sort configuration of the top bottom filter.
TopBottomFilter.Builder	aggregationSortConfigurations(Consumer<AggregationSortConfiguration.Builder>... aggregationSortConfigurations)	The aggregation and sort configuration of the top bottom filter.
TopBottomFilter.Builder	aggregationSortConfigurations(AggregationSortConfiguration... aggregationSortConfigurations)	The aggregation and sort configuration of the top bottom filter.
default TopBottomFilter.Builder	column(Consumer<ColumnIdentifier.Builder> column)	The column that the filter is applied to.
TopBottomFilter.Builder	column(ColumnIdentifier column)	The column that the filter is applied to.
default TopBottomFilter.Builder	defaultFilterControlConfiguration(Consumer<DefaultFilterControlConfiguration.Builder> defaultFilterControlConfiguration)	The default configurations for the associated controls.
TopBottomFilter.Builder	defaultFilterControlConfiguration(DefaultFilterControlConfiguration defaultFilterControlConfiguration)	The default configurations for the associated controls.
TopBottomFilter.Builder	filterId(String filterId)	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
TopBottomFilter.Builder	limit(Integer limit)	The number of items to include in the top bottom filter results.
TopBottomFilter.Builder	parameterName(String parameterName)	The parameter whose value should be used for the filter value.
TopBottomFilter.Builder	timeGranularity(String timeGranularity)	The level of time precision that is used to aggregate DateTime values.
TopBottomFilter.Builder	timeGranularity(TimeGranularity timeGranularity)	The level of time precision that is used to aggregate DateTime values.

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 the ColumnIdentifier.Builder avoiding the need to create one manually via ColumnIdentifier.builder().

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

Parameters:

column - a consumer that will call methods on ColumnIdentifier.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 the AggregationSortConfiguration.Builder avoiding the need to create one manually via AggregationSortConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #aggregationSortConfigurations(List).

Parameters:

aggregationSortConfigurations - a consumer that will call methods on AggregationSortConfiguration.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 DateTime values.

Parameters:

timeGranularity - The level of time precision that is used to aggregate DateTime values.

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 DateTime values.

Parameters:

timeGranularity - The level of time precision that is used to aggregate DateTime values.

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 the DefaultFilterControlConfiguration.Builder avoiding the need to create one manually via DefaultFilterControlConfiguration.builder().

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

Parameters:

defaultFilterControlConfiguration - a consumer that will call methods on DefaultFilterControlConfiguration.Builder

Returns:

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

See Also:

defaultFilterControlConfiguration(DefaultFilterControlConfiguration)