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.NumericRangeFilter

Description

Synopsis

Documentation

data NumericRangeFilter Source #

A NumericRangeFilter filters values that are within the value range.

See: newNumericRangeFilter smart constructor.

Constructors

NumericRangeFilter'

Fields

aggregationFunction :: Maybe AggregationFunction
The aggregation function of the 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.
rangeMaximum :: Maybe NumericRangeFilterValue
The maximum value for the filter value range.
rangeMinimum :: Maybe NumericRangeFilterValue
The minimum value for the filter value range.
selectAllOptions :: Maybe NumericFilterSelectAllOptions
Select all of the values. Null is not the assigned value of select all.
- ```
FILTER_ALL_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 NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods parseJSON :: Value -> Parser NumericRangeFilter # parseJSONList :: Value -> Parser [NumericRangeFilter] #
ToJSON NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods toJSON :: NumericRangeFilter -> Value # toEncoding :: NumericRangeFilter -> Encoding # toJSONList :: [NumericRangeFilter] -> Value # toEncodingList :: [NumericRangeFilter] -> Encoding #
Generic NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Associated Types type Rep NumericRangeFilter :: Type -> Type # Methods from :: NumericRangeFilter -> Rep NumericRangeFilter x # to :: Rep NumericRangeFilter x -> NumericRangeFilter #
Read NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods readsPrec :: Int -> ReadS NumericRangeFilter # readList :: ReadS [NumericRangeFilter] # readPrec :: ReadPrec NumericRangeFilter # readListPrec :: ReadPrec [NumericRangeFilter] #
Show NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods showsPrec :: Int -> NumericRangeFilter -> ShowS # show :: NumericRangeFilter -> String # showList :: [NumericRangeFilter] -> ShowS #
NFData NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods rnf :: NumericRangeFilter -> () #
Eq NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods (==) :: NumericRangeFilter -> NumericRangeFilter -> Bool # (/=) :: NumericRangeFilter -> NumericRangeFilter -> Bool #
Hashable NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter Methods hashWithSalt :: Int -> NumericRangeFilter -> Int # hash :: NumericRangeFilter -> Int #
type Rep NumericRangeFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericRangeFilter type Rep NumericRangeFilter = D1 ('MetaData "NumericRangeFilter" "Amazonka.QuickSight.Types.NumericRangeFilter" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "NumericRangeFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aggregationFunction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationFunction)) :: S1 ('MetaSel ('Just "includeMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "includeMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "rangeMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumericRangeFilterValue)))) :: ((S1 ('MetaSel ('Just "rangeMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumericRangeFilterValue)) :: S1 ('MetaSel ('Just "selectAllOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumericFilterSelectAllOptions))) :: (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))))))

newNumericRangeFilter Source #

Arguments

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

Create a value of NumericRangeFilter 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:aggregationFunction:NumericRangeFilter', numericRangeFilter_aggregationFunction - The aggregation function of the filter.

$sel:includeMaximum:NumericRangeFilter', numericRangeFilter_includeMaximum - Determines whether the maximum value in the filter value range should be included in the filtered results.

$sel:includeMinimum:NumericRangeFilter', numericRangeFilter_includeMinimum - Determines whether the minimum value in the filter value range should be included in the filtered results.

$sel:rangeMaximum:NumericRangeFilter', numericRangeFilter_rangeMaximum - The maximum value for the filter value range.

$sel:rangeMinimum:NumericRangeFilter', numericRangeFilter_rangeMinimum - The minimum value for the filter value range.

$sel:selectAllOptions:NumericRangeFilter', numericRangeFilter_selectAllOptions - Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

$sel:filterId:NumericRangeFilter', numericRangeFilter_filterId - An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

$sel:column:NumericRangeFilter', numericRangeFilter_column - The column that the filter is applied to.

$sel:nullOption:NumericRangeFilter', numericRangeFilter_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.

numericRangeFilter_aggregationFunction :: Lens' NumericRangeFilter (Maybe AggregationFunction) Source #

The aggregation function of the filter.

numericRangeFilter_includeMaximum :: Lens' NumericRangeFilter (Maybe Bool) Source #

Determines whether the maximum value in the filter value range should be included in the filtered results.

numericRangeFilter_includeMinimum :: Lens' NumericRangeFilter (Maybe Bool) Source #

Determines whether the minimum value in the filter value range should be included in the filtered results.

numericRangeFilter_rangeMaximum :: Lens' NumericRangeFilter (Maybe NumericRangeFilterValue) Source #

The maximum value for the filter value range.

numericRangeFilter_rangeMinimum :: Lens' NumericRangeFilter (Maybe NumericRangeFilterValue) Source #

The minimum value for the filter value range.

numericRangeFilter_selectAllOptions :: Lens' NumericRangeFilter (Maybe NumericFilterSelectAllOptions) Source #

Select all of the values. Null is not the assigned value of select all.

```
FILTER_ALL_VALUES
```

numericRangeFilter_filterId :: Lens' NumericRangeFilter Text Source #

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

numericRangeFilter_column :: Lens' NumericRangeFilter ColumnIdentifier Source #

The column that the filter is applied to.

numericRangeFilter_nullOption :: Lens' NumericRangeFilter 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.