Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data RelativeDatesFilter = RelativeDatesFilter' {
- excludePeriodConfiguration :: Maybe ExcludePeriodConfiguration
- minimumGranularity :: Maybe TimeGranularity
- parameterName :: Maybe Text
- relativeDateValue :: Maybe Int
- filterId :: Text
- column :: ColumnIdentifier
- anchorDateConfiguration :: AnchorDateConfiguration
- timeGranularity :: TimeGranularity
- relativeDateType :: RelativeDateType
- nullOption :: FilterNullOption
- newRelativeDatesFilter :: Text -> ColumnIdentifier -> AnchorDateConfiguration -> TimeGranularity -> RelativeDateType -> FilterNullOption -> RelativeDatesFilter
- relativeDatesFilter_excludePeriodConfiguration :: Lens' RelativeDatesFilter (Maybe ExcludePeriodConfiguration)
- relativeDatesFilter_minimumGranularity :: Lens' RelativeDatesFilter (Maybe TimeGranularity)
- relativeDatesFilter_parameterName :: Lens' RelativeDatesFilter (Maybe Text)
- relativeDatesFilter_relativeDateValue :: Lens' RelativeDatesFilter (Maybe Int)
- relativeDatesFilter_filterId :: Lens' RelativeDatesFilter Text
- relativeDatesFilter_column :: Lens' RelativeDatesFilter ColumnIdentifier
- relativeDatesFilter_anchorDateConfiguration :: Lens' RelativeDatesFilter AnchorDateConfiguration
- relativeDatesFilter_timeGranularity :: Lens' RelativeDatesFilter TimeGranularity
- relativeDatesFilter_relativeDateType :: Lens' RelativeDatesFilter RelativeDateType
- relativeDatesFilter_nullOption :: Lens' RelativeDatesFilter FilterNullOption
Documentation
data RelativeDatesFilter Source #
A RelativeDatesFilter
filters relative dates values.
See: newRelativeDatesFilter
smart constructor.
RelativeDatesFilter' | |
|
Instances
newRelativeDatesFilter Source #
:: Text | |
-> ColumnIdentifier | |
-> AnchorDateConfiguration | |
-> TimeGranularity | |
-> RelativeDateType | |
-> FilterNullOption | |
-> RelativeDatesFilter |
Create a value of RelativeDatesFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:excludePeriodConfiguration:RelativeDatesFilter'
, relativeDatesFilter_excludePeriodConfiguration
- The configuration for the exclude period of the filter.
$sel:minimumGranularity:RelativeDatesFilter'
, relativeDatesFilter_minimumGranularity
- The minimum granularity (period granularity) of the relative dates
filter.
RelativeDatesFilter
, relativeDatesFilter_parameterName
- The parameter whose value should be used for the filter value.
$sel:relativeDateValue:RelativeDatesFilter'
, relativeDatesFilter_relativeDateValue
- The date value of the filter.
$sel:filterId:RelativeDatesFilter'
, relativeDatesFilter_filterId
- An identifier that uniquely identifies a filter within a dashboard,
analysis, or template.
$sel:column:RelativeDatesFilter'
, relativeDatesFilter_column
- The column that the filter is applied to.
$sel:anchorDateConfiguration:RelativeDatesFilter'
, relativeDatesFilter_anchorDateConfiguration
- The date configuration of the filter.
$sel:timeGranularity:RelativeDatesFilter'
, relativeDatesFilter_timeGranularity
- The level of time precision that is used to aggregate DateTime
values.
$sel:relativeDateType:RelativeDatesFilter'
, relativeDatesFilter_relativeDateType
- The range date type of the filter. Choose one of the options below:
PREVIOUS
THIS
LAST
NOW
NEXT
$sel:nullOption:RelativeDatesFilter'
, relativeDatesFilter_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.
relativeDatesFilter_excludePeriodConfiguration :: Lens' RelativeDatesFilter (Maybe ExcludePeriodConfiguration) Source #
The configuration for the exclude period of the filter.
relativeDatesFilter_minimumGranularity :: Lens' RelativeDatesFilter (Maybe TimeGranularity) Source #
The minimum granularity (period granularity) of the relative dates filter.
relativeDatesFilter_parameterName :: Lens' RelativeDatesFilter (Maybe Text) Source #
The parameter whose value should be used for the filter value.
relativeDatesFilter_relativeDateValue :: Lens' RelativeDatesFilter (Maybe Int) Source #
The date value of the filter.
relativeDatesFilter_filterId :: Lens' RelativeDatesFilter Text Source #
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
relativeDatesFilter_column :: Lens' RelativeDatesFilter ColumnIdentifier Source #
The column that the filter is applied to.
relativeDatesFilter_anchorDateConfiguration :: Lens' RelativeDatesFilter AnchorDateConfiguration Source #
The date configuration of the filter.
relativeDatesFilter_timeGranularity :: Lens' RelativeDatesFilter TimeGranularity Source #
The level of time precision that is used to aggregate DateTime
values.
relativeDatesFilter_relativeDateType :: Lens' RelativeDatesFilter RelativeDateType Source #
The range date type of the filter. Choose one of the options below:
PREVIOUS
THIS
LAST
NOW
NEXT
relativeDatesFilter_nullOption :: Lens' RelativeDatesFilter FilterNullOption Source #
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.