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

Amazonka.QuickSight.Types.TimeRangeFilter

Description

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.

Constructors

TimeRangeFilter'

Fields

excludePeriodConfiguration :: Maybe ExcludePeriodConfiguration
The exclude period of the time range filter.
includeMaximum :: Maybe Bool
Determines whether the maximum value in the filter value range should be included in the filtered results.
includeMinimum :: Maybe Bool
Determines whether the minimum value in the filter value range should be included in the filtered results.
rangeMaximumValue :: Maybe TimeRangeFilterValue
The maximum value for the filter value range.
rangeMinimumValue :: Maybe TimeRangeFilterValue
The minimum value for the filter value range.
timeGranularity :: Maybe TimeGranularity
The level of time precision that is used to aggregate DateTime values.
filterId :: Text
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
column :: ColumnIdentifier
The column that the filter is applied to.
nullOption :: FilterNullOption
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.

Instances

Instances details

FromJSON TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods parseJSON :: Value -> Parser TimeRangeFilter # parseJSONList :: Value -> Parser [TimeRangeFilter] #
ToJSON TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods toJSON :: TimeRangeFilter -> Value # toEncoding :: TimeRangeFilter -> Encoding # toJSONList :: [TimeRangeFilter] -> Value # toEncodingList :: [TimeRangeFilter] -> Encoding #
Generic TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Associated Types type Rep TimeRangeFilter :: Type -> Type # Methods from :: TimeRangeFilter -> Rep TimeRangeFilter x # to :: Rep TimeRangeFilter x -> TimeRangeFilter #
Show TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods showsPrec :: Int -> TimeRangeFilter -> ShowS # show :: TimeRangeFilter -> String # showList :: [TimeRangeFilter] -> ShowS #
NFData TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods rnf :: TimeRangeFilter -> () #
Eq TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods (==) :: TimeRangeFilter -> TimeRangeFilter -> Bool # (/=) :: TimeRangeFilter -> TimeRangeFilter -> Bool #
Hashable TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter Methods hashWithSalt :: Int -> TimeRangeFilter -> Int # hash :: TimeRangeFilter -> Int #
type Rep TimeRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.TimeRangeFilter type Rep TimeRangeFilter = D1 ('MetaData "TimeRangeFilter" "Amazonka.QuickSight.Types.TimeRangeFilter" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "TimeRangeFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "excludePeriodConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExcludePeriodConfiguration)) :: S1 ('MetaSel ('Just "includeMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "includeMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "rangeMaximumValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRangeFilterValue)))) :: ((S1 ('MetaSel ('Just "rangeMinimumValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRangeFilterValue)) :: S1 ('MetaSel ('Just "timeGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeGranularity))) :: (S1 ('MetaSel ('Just "filterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "column") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnIdentifier) :: S1 ('MetaSel ('Just "nullOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterNullOption))))))

newTimeRangeFilter Source #

Arguments

:: Text	`$sel:filterId:TimeRangeFilter'`
-> ColumnIdentifier	`$sel:column:TimeRangeFilter'`
-> FilterNullOption	`$sel:nullOption:TimeRangeFilter'`
-> TimeRangeFilter

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.