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

Description

Synopsis

Documentation

data NumericEqualityFilter Source #

A NumericEqualityFilter filters values that are equal to the specified value.

See: newNumericEqualityFilter smart constructor.

Constructors

NumericEqualityFilter'

Fields

aggregationFunction :: Maybe AggregationFunction
The aggregation function of the filter.
parameterName :: Maybe Text
The parameter whose value should be used for the filter value.
selectAllOptions :: Maybe NumericFilterSelectAllOptions
Select all of the values. Null is not the assigned value of select all.
- ```
FILTER_ALL_VALUES
```
value :: Maybe Double
The input value.
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.
matchOperator :: NumericEqualityMatchOperator
The match operator that is used to determine if a filter should be applied.
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 NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods parseJSON :: Value -> Parser NumericEqualityFilter # parseJSONList :: Value -> Parser [NumericEqualityFilter] #
ToJSON NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods toJSON :: NumericEqualityFilter -> Value # toEncoding :: NumericEqualityFilter -> Encoding # toJSONList :: [NumericEqualityFilter] -> Value # toEncodingList :: [NumericEqualityFilter] -> Encoding #
Generic NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Associated Types type Rep NumericEqualityFilter :: Type -> Type # Methods from :: NumericEqualityFilter -> Rep NumericEqualityFilter x # to :: Rep NumericEqualityFilter x -> NumericEqualityFilter #
Read NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods readsPrec :: Int -> ReadS NumericEqualityFilter # readList :: ReadS [NumericEqualityFilter] # readPrec :: ReadPrec NumericEqualityFilter # readListPrec :: ReadPrec [NumericEqualityFilter] #
Show NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods showsPrec :: Int -> NumericEqualityFilter -> ShowS # show :: NumericEqualityFilter -> String # showList :: [NumericEqualityFilter] -> ShowS #
NFData NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods rnf :: NumericEqualityFilter -> () #
Eq NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods (==) :: NumericEqualityFilter -> NumericEqualityFilter -> Bool # (/=) :: NumericEqualityFilter -> NumericEqualityFilter -> Bool #
Hashable NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter Methods hashWithSalt :: Int -> NumericEqualityFilter -> Int # hash :: NumericEqualityFilter -> Int #
type Rep NumericEqualityFilter Source #
Instance details Defined in Amazonka.QuickSight.Types.NumericEqualityFilter type Rep NumericEqualityFilter = D1 ('MetaData "NumericEqualityFilter" "Amazonka.QuickSight.Types.NumericEqualityFilter" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "NumericEqualityFilter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aggregationFunction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationFunction)) :: S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "selectAllOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumericFilterSelectAllOptions)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "filterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "column") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnIdentifier)) :: (S1 ('MetaSel ('Just "matchOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NumericEqualityMatchOperator) :*: S1 ('MetaSel ('Just "nullOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterNullOption)))))

newNumericEqualityFilter Source #

Arguments

:: Text	`$sel:filterId:NumericEqualityFilter'`
-> ColumnIdentifier	`$sel:column:NumericEqualityFilter'`
-> NumericEqualityMatchOperator	`$sel:matchOperator:NumericEqualityFilter'`
-> FilterNullOption	`$sel:nullOption:NumericEqualityFilter'`
-> NumericEqualityFilter

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

$sel:parameterName:NumericEqualityFilter', numericEqualityFilter_parameterName - The parameter whose value should be used for the filter value.

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

```
FILTER_ALL_VALUES
```

$sel:value:NumericEqualityFilter', numericEqualityFilter_value - The input value.

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

$sel:column:NumericEqualityFilter', numericEqualityFilter_column - The column that the filter is applied to.

$sel:matchOperator:NumericEqualityFilter', numericEqualityFilter_matchOperator - The match operator that is used to determine if a filter should be applied.

$sel:nullOption:NumericEqualityFilter', numericEqualityFilter_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.

numericEqualityFilter_aggregationFunction :: Lens' NumericEqualityFilter (Maybe AggregationFunction) Source #

The aggregation function of the filter.

numericEqualityFilter_parameterName :: Lens' NumericEqualityFilter (Maybe Text) Source #

The parameter whose value should be used for the filter value.

numericEqualityFilter_selectAllOptions :: Lens' NumericEqualityFilter (Maybe NumericFilterSelectAllOptions) Source #

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

```
FILTER_ALL_VALUES
```

numericEqualityFilter_value :: Lens' NumericEqualityFilter (Maybe Double) Source #

The input value.

numericEqualityFilter_filterId :: Lens' NumericEqualityFilter Text Source #

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

numericEqualityFilter_column :: Lens' NumericEqualityFilter ColumnIdentifier Source #

The column that the filter is applied to.

numericEqualityFilter_matchOperator :: Lens' NumericEqualityFilter NumericEqualityMatchOperator Source #

The match operator that is used to determine if a filter should be applied.

numericEqualityFilter_nullOption :: Lens' NumericEqualityFilter 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.