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 TimeRangeFilter = TimeRangeFilter' {
- excludePeriodConfiguration :: Maybe ExcludePeriodConfiguration
- includeMaximum :: Maybe Bool
- includeMinimum :: Maybe Bool
- rangeMaximumValue :: Maybe TimeRangeFilterValue
- rangeMinimumValue :: Maybe TimeRangeFilterValue
- timeGranularity :: Maybe TimeGranularity
- filterId :: Text
- column :: ColumnIdentifier
- nullOption :: FilterNullOption
- newTimeRangeFilter :: Text -> ColumnIdentifier -> FilterNullOption -> TimeRangeFilter
- timeRangeFilter_excludePeriodConfiguration :: Lens' TimeRangeFilter (Maybe ExcludePeriodConfiguration)
- timeRangeFilter_includeMaximum :: Lens' TimeRangeFilter (Maybe Bool)
- timeRangeFilter_includeMinimum :: Lens' TimeRangeFilter (Maybe Bool)
- timeRangeFilter_rangeMaximumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue)
- timeRangeFilter_rangeMinimumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue)
- timeRangeFilter_timeGranularity :: Lens' TimeRangeFilter (Maybe TimeGranularity)
- timeRangeFilter_filterId :: Lens' TimeRangeFilter Text
- timeRangeFilter_column :: Lens' TimeRangeFilter ColumnIdentifier
- timeRangeFilter_nullOption :: Lens' TimeRangeFilter FilterNullOption
Documentation
data TimeRangeFilter Source #
A TimeRangeFilter
filters values that are between two specified
values.
See: newTimeRangeFilter
smart constructor.
TimeRangeFilter' | |
|
Instances
Create a value of TimeRangeFilter
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:TimeRangeFilter'
, timeRangeFilter_excludePeriodConfiguration
- The exclude period of the time range filter.
$sel:includeMaximum:TimeRangeFilter'
, timeRangeFilter_includeMaximum
- Determines whether the maximum value in the filter value range should be
included in the filtered results.
$sel:includeMinimum:TimeRangeFilter'
, timeRangeFilter_includeMinimum
- Determines whether the minimum value in the filter value range should be
included in the filtered results.
$sel:rangeMaximumValue:TimeRangeFilter'
, timeRangeFilter_rangeMaximumValue
- The maximum value for the filter value range.
$sel:rangeMinimumValue:TimeRangeFilter'
, timeRangeFilter_rangeMinimumValue
- The minimum value for the filter value range.
$sel:timeGranularity:TimeRangeFilter'
, timeRangeFilter_timeGranularity
- The level of time precision that is used to aggregate DateTime
values.
$sel:filterId:TimeRangeFilter'
, timeRangeFilter_filterId
- An identifier that uniquely identifies a filter within a dashboard,
analysis, or template.
$sel:column:TimeRangeFilter'
, timeRangeFilter_column
- The column that the filter is applied to.
$sel:nullOption:TimeRangeFilter'
, timeRangeFilter_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.
timeRangeFilter_excludePeriodConfiguration :: Lens' TimeRangeFilter (Maybe ExcludePeriodConfiguration) Source #
The exclude period of the time range filter.
timeRangeFilter_includeMaximum :: Lens' TimeRangeFilter (Maybe Bool) Source #
Determines whether the maximum value in the filter value range should be included in the filtered results.
timeRangeFilter_includeMinimum :: Lens' TimeRangeFilter (Maybe Bool) Source #
Determines whether the minimum value in the filter value range should be included in the filtered results.
timeRangeFilter_rangeMaximumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue) Source #
The maximum value for the filter value range.
timeRangeFilter_rangeMinimumValue :: Lens' TimeRangeFilter (Maybe TimeRangeFilterValue) Source #
The minimum value for the filter value range.
timeRangeFilter_timeGranularity :: Lens' TimeRangeFilter (Maybe TimeGranularity) Source #
The level of time precision that is used to aggregate DateTime
values.
timeRangeFilter_filterId :: Lens' TimeRangeFilter Text Source #
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
timeRangeFilter_column :: Lens' TimeRangeFilter ColumnIdentifier Source #
The column that the filter is applied to.
timeRangeFilter_nullOption :: Lens' TimeRangeFilter 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.