Class CfnDashboard.TimeRangeFilterProperty.Builder
java.lang.Object
software.amazon.awscdk.services.quicksight.CfnDashboard.TimeRangeFilterProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>
- Enclosing interface:
CfnDashboard.TimeRangeFilterProperty
@Stability(Stable)
public static final class CfnDashboard.TimeRangeFilterProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>
A builder for
CfnDashboard.TimeRangeFilterProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.column
(IResolvable column) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getColumn()
Sets the value ofCfnDashboard.TimeRangeFilterProperty.getColumn()
defaultFilterControlConfiguration
(IResolvable defaultFilterControlConfiguration) defaultFilterControlConfiguration
(CfnDashboard.DefaultFilterControlConfigurationProperty defaultFilterControlConfiguration) excludePeriodConfiguration
(IResolvable excludePeriodConfiguration) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
excludePeriodConfiguration
(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
Sets the value ofCfnDashboard.TimeRangeFilterProperty.getFilterId()
includeMaximum
(Boolean includeMaximum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
includeMaximum
(IResolvable includeMaximum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
includeMinimum
(Boolean includeMinimum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
includeMinimum
(IResolvable includeMinimum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
nullOption
(String nullOption) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getNullOption()
rangeMaximumValue
(IResolvable rangeMaximumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
rangeMaximumValue
(CfnDashboard.TimeRangeFilterValueProperty rangeMaximumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
rangeMinimumValue
(IResolvable rangeMinimumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
rangeMinimumValue
(CfnDashboard.TimeRangeFilterValueProperty rangeMinimumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
timeGranularity
(String timeGranularity) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getTimeGranularity()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
column
Sets the value ofCfnDashboard.TimeRangeFilterProperty.getColumn()
- Parameters:
column
- The column that the filter is applied to. This parameter is required.- Returns:
this
-
column
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder column(CfnDashboard.ColumnIdentifierProperty column) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getColumn()
- Parameters:
column
- The column that the filter is applied to. This parameter is required.- Returns:
this
-
filterId
Sets the value ofCfnDashboard.TimeRangeFilterProperty.getFilterId()
- Parameters:
filterId
- An identifier that uniquely identifies a filter within a dashboard, analysis, or template. This parameter is required.- Returns:
this
-
nullOption
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder nullOption(String nullOption) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getNullOption()
- Parameters:
nullOption
- This option determines how null values should be treated when filtering data. This parameter is required.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:
this
-
defaultFilterControlConfiguration
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder defaultFilterControlConfiguration(IResolvable defaultFilterControlConfiguration) - Parameters:
defaultFilterControlConfiguration
- The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.- Returns:
this
-
defaultFilterControlConfiguration
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder defaultFilterControlConfiguration(CfnDashboard.DefaultFilterControlConfigurationProperty defaultFilterControlConfiguration) - Parameters:
defaultFilterControlConfiguration
- The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.- Returns:
this
-
excludePeriodConfiguration
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder excludePeriodConfiguration(IResolvable excludePeriodConfiguration) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
- Parameters:
excludePeriodConfiguration
- The exclude period of the time range filter.- Returns:
this
-
excludePeriodConfiguration
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder excludePeriodConfiguration(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getExcludePeriodConfiguration()
- Parameters:
excludePeriodConfiguration
- The exclude period of the time range filter.- Returns:
this
-
includeMaximum
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder includeMaximum(Boolean includeMaximum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
- Parameters:
includeMaximum
- Determines whether the maximum value in the filter value range should be included in the filtered results.- Returns:
this
-
includeMaximum
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder includeMaximum(IResolvable includeMaximum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMaximum()
- Parameters:
includeMaximum
- Determines whether the maximum value in the filter value range should be included in the filtered results.- Returns:
this
-
includeMinimum
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder includeMinimum(Boolean includeMinimum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
- Parameters:
includeMinimum
- Determines whether the minimum value in the filter value range should be included in the filtered results.- Returns:
this
-
includeMinimum
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder includeMinimum(IResolvable includeMinimum) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getIncludeMinimum()
- Parameters:
includeMinimum
- Determines whether the minimum value in the filter value range should be included in the filtered results.- Returns:
this
-
rangeMaximumValue
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder rangeMaximumValue(IResolvable rangeMaximumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
- Parameters:
rangeMaximumValue
- The maximum value for the filter value range.- Returns:
this
-
rangeMaximumValue
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder rangeMaximumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMaximumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMaximumValue()
- Parameters:
rangeMaximumValue
- The maximum value for the filter value range.- Returns:
this
-
rangeMinimumValue
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder rangeMinimumValue(IResolvable rangeMinimumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
- Parameters:
rangeMinimumValue
- The minimum value for the filter value range.- Returns:
this
-
rangeMinimumValue
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder rangeMinimumValue(CfnDashboard.TimeRangeFilterValueProperty rangeMinimumValue) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getRangeMinimumValue()
- Parameters:
rangeMinimumValue
- The minimum value for the filter value range.- Returns:
this
-
timeGranularity
@Stability(Stable) public CfnDashboard.TimeRangeFilterProperty.Builder timeGranularity(String timeGranularity) Sets the value ofCfnDashboard.TimeRangeFilterProperty.getTimeGranularity()
- Parameters:
timeGranularity
- The level of time precision that is used to aggregateDateTime
values.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDashboard.TimeRangeFilterProperty>
- Returns:
- a new instance of
CfnDashboard.TimeRangeFilterProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-