Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.TimeRangeFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.TimeRangeFilterProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.TimeRangeFilterProperty
extends software.amazon.jsii.JsiiSerializable

A TimeRangeFilter filters values that are between two specified values.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 TimeRangeFilterProperty timeRangeFilterProperty = TimeRangeFilterProperty.builder()
         .column(ColumnIdentifierProperty.builder()
                 .columnName("columnName")
                 .dataSetIdentifier("dataSetIdentifier")
                 .build())
         .filterId("filterId")
         .nullOption("nullOption")
         // the properties below are optional
         .excludePeriodConfiguration(ExcludePeriodConfigurationProperty.builder()
                 .amount(123)
                 .granularity("granularity")
                 // the properties below are optional
                 .status("status")
                 .build())
         .includeMaximum(false)
         .includeMinimum(false)
         .rangeMaximumValue(TimeRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .rollingDate(RollingDateConfigurationProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .staticValue("staticValue")
                 .build())
         .rangeMinimumValue(TimeRangeFilterValueProperty.builder()
                 .parameter("parameter")
                 .rollingDate(RollingDateConfigurationProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .dataSetIdentifier("dataSetIdentifier")
                         .build())
                 .staticValue("staticValue")
                 .build())
         .timeGranularity("timeGranularity")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.TimeRangeFilterProperty.Builder	A builder for CfnDashboard.TimeRangeFilterProperty
static final class	CfnDashboard.TimeRangeFilterProperty.Jsii$Proxy	An implementation for CfnDashboard.TimeRangeFilterProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.TimeRangeFilterProperty.Builder	builder()
Object	getColumn()	The column that the filter is applied to.
default Object	getExcludePeriodConfiguration()	The exclude period of the time range filter.
String	getFilterId()	An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
default Object	getIncludeMaximum()	Determines whether the maximum value in the filter value range should be included in the filtered results.
default Object	getIncludeMinimum()	Determines whether the minimum value in the filter value range should be included in the filtered results.
String	getNullOption()	This option determines how null values should be treated when filtering data.
default Object	getRangeMaximumValue()	The maximum value for the filter value range.
default Object	getRangeMinimumValue()	The minimum value for the filter value range.
default String	getTimeGranularity()	The level of time precision that is used to aggregate DateTime values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColumn

@Stability(Stable)
@NotNull
Object getColumn()

The column that the filter is applied to.

getFilterId

@Stability(Stable)
@NotNull
String getFilterId()

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

getNullOption

@Stability(Stable)
@NotNull
String getNullOption()

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.

getExcludePeriodConfiguration

@Stability(Stable)
@Nullable
default Object getExcludePeriodConfiguration()

The exclude period of the time range filter.

getIncludeMaximum

@Stability(Stable)
@Nullable
default Object getIncludeMaximum()

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

getIncludeMinimum

@Stability(Stable)
@Nullable
default Object getIncludeMinimum()

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

getRangeMaximumValue

@Stability(Stable)
@Nullable
default Object getRangeMaximumValue()

The maximum value for the filter value range.

getRangeMinimumValue

@Stability(Stable)
@Nullable
default Object getRangeMinimumValue()

The minimum value for the filter value range.

getTimeGranularity

@Stability(Stable)
@Nullable
default String getTimeGranularity()

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

builder

@Stability(Stable)
static CfnDashboard.TimeRangeFilterProperty.Builder builder()

Returns:

a CfnDashboard.TimeRangeFilterProperty.Builder of CfnDashboard.TimeRangeFilterProperty