software.amazon.awssdk.services.quicksight.model

Interface TimeRangeFilter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TimeRangeFilter.Builder,TimeRangeFilter>, SdkBuilder<TimeRangeFilter.Builder,TimeRangeFilter>, SdkPojo

Enclosing class:

TimeRangeFilter

public static interface TimeRangeFilter.Builder
extends SdkPojo, CopyableBuilder<TimeRangeFilter.Builder,TimeRangeFilter>

Method Summary

Modifier and Type	Method and Description
TimeRangeFilter.Builder	column(ColumnIdentifier column) The column that the filter is applied to.
default TimeRangeFilter.Builder	column(Consumer<ColumnIdentifier.Builder> column) The column that the filter is applied to.
default TimeRangeFilter.Builder	excludePeriodConfiguration(Consumer<ExcludePeriodConfiguration.Builder> excludePeriodConfiguration) The exclude period of the time range filter.
TimeRangeFilter.Builder	excludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration) The exclude period of the time range filter.
TimeRangeFilter.Builder	filterId(String filterId) An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
TimeRangeFilter.Builder	includeMaximum(Boolean includeMaximum) Determines whether the maximum value in the filter value range should be included in the filtered results.
TimeRangeFilter.Builder	includeMinimum(Boolean includeMinimum) Determines whether the minimum value in the filter value range should be included in the filtered results.
TimeRangeFilter.Builder	nullOption(FilterNullOption nullOption) This option determines how null values should be treated when filtering data.
TimeRangeFilter.Builder	nullOption(String nullOption) This option determines how null values should be treated when filtering data.
default TimeRangeFilter.Builder	rangeMaximumValue(Consumer<TimeRangeFilterValue.Builder> rangeMaximumValue) The maximum value for the filter value range.
TimeRangeFilter.Builder	rangeMaximumValue(TimeRangeFilterValue rangeMaximumValue) The maximum value for the filter value range.
default TimeRangeFilter.Builder	rangeMinimumValue(Consumer<TimeRangeFilterValue.Builder> rangeMinimumValue) The minimum value for the filter value range.
TimeRangeFilter.Builder	rangeMinimumValue(TimeRangeFilterValue rangeMinimumValue) The minimum value for the filter value range.
TimeRangeFilter.Builder	timeGranularity(String timeGranularity) The level of time precision that is used to aggregate DateTime values.
TimeRangeFilter.Builder	timeGranularity(TimeGranularity timeGranularity) The level of time precision that is used to aggregate DateTime values.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

filterId

TimeRangeFilter.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

TimeRangeFilter.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 TimeRangeFilter.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)

includeMinimum

TimeRangeFilter.Builder includeMinimum(Boolean includeMinimum)

Determines whether the minimum value in the filter value range should be included in the filtered results.

Parameters:

includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

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

includeMaximum

TimeRangeFilter.Builder includeMaximum(Boolean includeMaximum)

Determines whether the maximum value in the filter value range should be included in the filtered results.

Parameters:

includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

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

rangeMinimumValue

TimeRangeFilter.Builder rangeMinimumValue(TimeRangeFilterValue rangeMinimumValue)

The minimum value for the filter value range.

Parameters:

rangeMinimumValue - The minimum value for the filter value range.

Returns:

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

rangeMinimumValue

default TimeRangeFilter.Builder rangeMinimumValue(Consumer<TimeRangeFilterValue.Builder> rangeMinimumValue)

The minimum value for the filter value range.

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

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

Parameters:

rangeMinimumValue - a consumer that will call methods on TimeRangeFilterValue.Builder

Returns:

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

See Also:

rangeMinimumValue(TimeRangeFilterValue)

rangeMaximumValue

TimeRangeFilter.Builder rangeMaximumValue(TimeRangeFilterValue rangeMaximumValue)

The maximum value for the filter value range.

Parameters:

rangeMaximumValue - The maximum value for the filter value range.

Returns:

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

rangeMaximumValue

default TimeRangeFilter.Builder rangeMaximumValue(Consumer<TimeRangeFilterValue.Builder> rangeMaximumValue)

The maximum value for the filter value range.

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

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

Parameters:

rangeMaximumValue - a consumer that will call methods on TimeRangeFilterValue.Builder

Returns:

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

See Also:

rangeMaximumValue(TimeRangeFilterValue)

nullOption

TimeRangeFilter.Builder nullOption(String nullOption)

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

Parameters:

nullOption - This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

Returns:

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

See Also:

FilterNullOption, FilterNullOption

nullOption

TimeRangeFilter.Builder nullOption(FilterNullOption nullOption)

This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

Parameters:

nullOption - This option determines how null values should be treated when filtering data.

• ALL_VALUES: Include null values in filtered results.

• NULLS_ONLY: Only include null values in filtered results.

• NON_NULLS_ONLY: Exclude null values from filtered results.

Returns:

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

See Also:

FilterNullOption, FilterNullOption

excludePeriodConfiguration

TimeRangeFilter.Builder excludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)

The exclude period of the time range filter.

Parameters:

excludePeriodConfiguration - The exclude period of the time range filter.

Returns:

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

excludePeriodConfiguration

default TimeRangeFilter.Builder excludePeriodConfiguration(Consumer<ExcludePeriodConfiguration.Builder> excludePeriodConfiguration)

The exclude period of the time range filter.

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

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

Parameters:

excludePeriodConfiguration - a consumer that will call methods on ExcludePeriodConfiguration.Builder

Returns:

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

See Also:

excludePeriodConfiguration(ExcludePeriodConfiguration)

timeGranularity

TimeRangeFilter.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

TimeRangeFilter.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