software.amazon.awssdk.services.quicksight.model

Interface RelativeDatesFilter.Builder

All Superinterfaces:

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

Enclosing class:

RelativeDatesFilter

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

Method Summary

Modifier and Type	Method and Description
RelativeDatesFilter.Builder	anchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration) The date configuration of the filter.
default RelativeDatesFilter.Builder	anchorDateConfiguration(Consumer<AnchorDateConfiguration.Builder> anchorDateConfiguration) The date configuration of the filter.
RelativeDatesFilter.Builder	column(ColumnIdentifier column) The column that the filter is applied to.
default RelativeDatesFilter.Builder	column(Consumer<ColumnIdentifier.Builder> column) The column that the filter is applied to.
default RelativeDatesFilter.Builder	excludePeriodConfiguration(Consumer<ExcludePeriodConfiguration.Builder> excludePeriodConfiguration) The configuration for the exclude period of the filter.
RelativeDatesFilter.Builder	excludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration) The configuration for the exclude period of the filter.
RelativeDatesFilter.Builder	filterId(String filterId) An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
RelativeDatesFilter.Builder	minimumGranularity(String minimumGranularity) The minimum granularity (period granularity) of the relative dates filter.
RelativeDatesFilter.Builder	minimumGranularity(TimeGranularity minimumGranularity) The minimum granularity (period granularity) of the relative dates filter.
RelativeDatesFilter.Builder	nullOption(FilterNullOption nullOption) This option determines how null values should be treated when filtering data.
RelativeDatesFilter.Builder	nullOption(String nullOption) This option determines how null values should be treated when filtering data.
RelativeDatesFilter.Builder	parameterName(String parameterName) The parameter whose value should be used for the filter value.
RelativeDatesFilter.Builder	relativeDateType(RelativeDateType relativeDateType) The range date type of the filter.
RelativeDatesFilter.Builder	relativeDateType(String relativeDateType) The range date type of the filter.
RelativeDatesFilter.Builder	relativeDateValue(Integer relativeDateValue) The date value of the filter.
RelativeDatesFilter.Builder	timeGranularity(String timeGranularity) The level of time precision that is used to aggregate DateTime values.
RelativeDatesFilter.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

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

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

anchorDateConfiguration

RelativeDatesFilter.Builder anchorDateConfiguration(AnchorDateConfiguration anchorDateConfiguration)

The date configuration of the filter.

Parameters:

anchorDateConfiguration - The date configuration of the filter.

Returns:

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

anchorDateConfiguration

default RelativeDatesFilter.Builder anchorDateConfiguration(Consumer<AnchorDateConfiguration.Builder> anchorDateConfiguration)

The date configuration of the filter.

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

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

Parameters:

anchorDateConfiguration - a consumer that will call methods on AnchorDateConfiguration.Builder

Returns:

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

See Also:

anchorDateConfiguration(AnchorDateConfiguration)

minimumGranularity

RelativeDatesFilter.Builder minimumGranularity(String minimumGranularity)

The minimum granularity (period granularity) of the relative dates filter.

Parameters:

minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.

Returns:

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

See Also:

TimeGranularity, TimeGranularity

minimumGranularity

RelativeDatesFilter.Builder minimumGranularity(TimeGranularity minimumGranularity)

The minimum granularity (period granularity) of the relative dates filter.

Parameters:

minimumGranularity - The minimum granularity (period granularity) of the relative dates filter.

Returns:

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

See Also:

TimeGranularity, TimeGranularity

timeGranularity

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

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

relativeDateType

RelativeDatesFilter.Builder relativeDateType(String relativeDateType)

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

Parameters:

relativeDateType - The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

Returns:

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

See Also:

RelativeDateType, RelativeDateType

relativeDateType

RelativeDatesFilter.Builder relativeDateType(RelativeDateType relativeDateType)

The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

Parameters:

relativeDateType - The range date type of the filter. Choose one of the options below:

• PREVIOUS

• THIS

• LAST

• NOW

• NEXT

Returns:

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

See Also:

RelativeDateType, RelativeDateType

relativeDateValue

RelativeDatesFilter.Builder relativeDateValue(Integer relativeDateValue)

The date value of the filter.

Parameters:

relativeDateValue - The date value of the filter.

Returns:

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

parameterName

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

nullOption

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

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

RelativeDatesFilter.Builder excludePeriodConfiguration(ExcludePeriodConfiguration excludePeriodConfiguration)

The configuration for the exclude period of the filter.

Parameters:

excludePeriodConfiguration - The configuration for the exclude period of the filter.

Returns:

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

excludePeriodConfiguration

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

The configuration for the exclude period of the 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)