Class CfnDashboard.RelativeDatesFilterProperty.Builder
java.lang.Object
software.amazon.awscdk.services.quicksight.CfnDashboard.RelativeDatesFilterProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDashboard.RelativeDatesFilterProperty>
- Enclosing interface:
CfnDashboard.RelativeDatesFilterProperty
@Stability(Stable)
public static final class CfnDashboard.RelativeDatesFilterProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard.RelativeDatesFilterProperty>
A builder for
CfnDashboard.RelativeDatesFilterProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionanchorDateConfiguration
(IResolvable anchorDateConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getAnchorDateConfiguration()
anchorDateConfiguration
(CfnDashboard.AnchorDateConfigurationProperty anchorDateConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getAnchorDateConfiguration()
build()
Builds the configured instance.column
(IResolvable column) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getColumn()
Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getColumn()
defaultFilterControlConfiguration
(IResolvable defaultFilterControlConfiguration) defaultFilterControlConfiguration
(CfnDashboard.DefaultFilterControlConfigurationProperty defaultFilterControlConfiguration) excludePeriodConfiguration
(IResolvable excludePeriodConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getExcludePeriodConfiguration()
excludePeriodConfiguration
(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getExcludePeriodConfiguration()
Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getFilterId()
minimumGranularity
(String minimumGranularity) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getMinimumGranularity()
nullOption
(String nullOption) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getNullOption()
parameterName
(String parameterName) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getParameterName()
relativeDateType
(String relativeDateType) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getRelativeDateType()
relativeDateValue
(Number relativeDateValue) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getRelativeDateValue()
timeGranularity
(String timeGranularity) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getTimeGranularity()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
anchorDateConfiguration
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder anchorDateConfiguration(IResolvable anchorDateConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getAnchorDateConfiguration()
- Parameters:
anchorDateConfiguration
- The date configuration of the filter. This parameter is required.- Returns:
this
-
anchorDateConfiguration
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder anchorDateConfiguration(CfnDashboard.AnchorDateConfigurationProperty anchorDateConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getAnchorDateConfiguration()
- Parameters:
anchorDateConfiguration
- The date configuration of the filter. This parameter is required.- Returns:
this
-
column
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder column(IResolvable column) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getColumn()
- Parameters:
column
- The column that the filter is applied to. This parameter is required.- Returns:
this
-
column
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder column(CfnDashboard.ColumnIdentifierProperty column) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getColumn()
- Parameters:
column
- The column that the filter is applied to. This parameter is required.- Returns:
this
-
filterId
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder filterId(String filterId) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.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.RelativeDatesFilterProperty.Builder nullOption(String nullOption) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.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
-
relativeDateType
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder relativeDateType(String relativeDateType) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getRelativeDateType()
- Parameters:
relativeDateType
- The range date type of the filter. Choose one of the options below:. This parameter is required.PREVIOUS
THIS
LAST
NOW
NEXT
- Returns:
this
-
timeGranularity
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder timeGranularity(String timeGranularity) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getTimeGranularity()
- Parameters:
timeGranularity
- The level of time precision that is used to aggregateDateTime
values. This parameter is required.- Returns:
this
-
defaultFilterControlConfiguration
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.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.RelativeDatesFilterProperty.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.RelativeDatesFilterProperty.Builder excludePeriodConfiguration(IResolvable excludePeriodConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getExcludePeriodConfiguration()
- Parameters:
excludePeriodConfiguration
- The configuration for the exclude period of the filter.- Returns:
this
-
excludePeriodConfiguration
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder excludePeriodConfiguration(CfnDashboard.ExcludePeriodConfigurationProperty excludePeriodConfiguration) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getExcludePeriodConfiguration()
- Parameters:
excludePeriodConfiguration
- The configuration for the exclude period of the filter.- Returns:
this
-
minimumGranularity
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder minimumGranularity(String minimumGranularity) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getMinimumGranularity()
- Parameters:
minimumGranularity
- The minimum granularity (period granularity) of the relative dates filter.- Returns:
this
-
parameterName
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder parameterName(String parameterName) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getParameterName()
- Parameters:
parameterName
- The parameter whose value should be used for the filter value.- Returns:
this
-
relativeDateValue
@Stability(Stable) public CfnDashboard.RelativeDatesFilterProperty.Builder relativeDateValue(Number relativeDateValue) Sets the value ofCfnDashboard.RelativeDatesFilterProperty.getRelativeDateValue()
- Parameters:
relativeDateValue
- The date value of the filter.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDashboard.RelativeDatesFilterProperty>
- Returns:
- a new instance of
CfnDashboard.RelativeDatesFilterProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-