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

Description

Synopsis

Documentation

data CustomFilterConfiguration Source #

A custom filter that filters based on a single value. This filter can be partially matched.

See: newCustomFilterConfiguration smart constructor.

Constructors

CustomFilterConfiguration'

Fields

categoryValue :: Maybe Text
The category value for the filter.
This field is mutually exclusive to ParameterName.
parameterName :: Maybe Text
The parameter whose value should be used for the filter value.
This field is mutually exclusive to CategoryValue.
selectAllOptions :: Maybe CategoryFilterSelectAllOptions
Select all of the values. Null is not the assigned value of select all.
- ```
FILTER_ALL_VALUES
```
matchOperator :: CategoryFilterMatchOperator
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 CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods parseJSON :: Value -> Parser CustomFilterConfiguration # parseJSONList :: Value -> Parser [CustomFilterConfiguration] #
ToJSON CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods toJSON :: CustomFilterConfiguration -> Value # toEncoding :: CustomFilterConfiguration -> Encoding # toJSONList :: [CustomFilterConfiguration] -> Value # toEncodingList :: [CustomFilterConfiguration] -> Encoding #
Generic CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Associated Types type Rep CustomFilterConfiguration :: Type -> Type # Methods from :: CustomFilterConfiguration -> Rep CustomFilterConfiguration x # to :: Rep CustomFilterConfiguration x -> CustomFilterConfiguration #
Read CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods readsPrec :: Int -> ReadS CustomFilterConfiguration # readList :: ReadS [CustomFilterConfiguration] # readPrec :: ReadPrec CustomFilterConfiguration # readListPrec :: ReadPrec [CustomFilterConfiguration] #
Show CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods showsPrec :: Int -> CustomFilterConfiguration -> ShowS # show :: CustomFilterConfiguration -> String # showList :: [CustomFilterConfiguration] -> ShowS #
NFData CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods rnf :: CustomFilterConfiguration -> () #
Eq CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods (==) :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool # (/=) :: CustomFilterConfiguration -> CustomFilterConfiguration -> Bool #
Hashable CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration Methods hashWithSalt :: Int -> CustomFilterConfiguration -> Int # hash :: CustomFilterConfiguration -> Int #
type Rep CustomFilterConfiguration Source #
Instance details Defined in Amazonka.QuickSight.Types.CustomFilterConfiguration type Rep CustomFilterConfiguration = D1 ('MetaData "CustomFilterConfiguration" "Amazonka.QuickSight.Types.CustomFilterConfiguration" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CustomFilterConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "categoryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "selectAllOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CategoryFilterSelectAllOptions)) :: (S1 ('MetaSel ('Just "matchOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CategoryFilterMatchOperator) :: S1 ('MetaSel ('Just "nullOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterNullOption)))))

newCustomFilterConfiguration Source #

Arguments

:: CategoryFilterMatchOperator	`$sel:matchOperator:CustomFilterConfiguration'`
-> FilterNullOption	`$sel:nullOption:CustomFilterConfiguration'`
-> CustomFilterConfiguration

Create a value of CustomFilterConfiguration 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:categoryValue:CustomFilterConfiguration', customFilterConfiguration_categoryValue - The category value for the filter.

This field is mutually exclusive to ParameterName.

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

This field is mutually exclusive to CategoryValue.

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

```
FILTER_ALL_VALUES
```

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

$sel:nullOption:CustomFilterConfiguration', customFilterConfiguration_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.

customFilterConfiguration_categoryValue :: Lens' CustomFilterConfiguration (Maybe Text) Source #

The category value for the filter.

This field is mutually exclusive to ParameterName.

customFilterConfiguration_parameterName :: Lens' CustomFilterConfiguration (Maybe Text) Source #

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

This field is mutually exclusive to CategoryValue.

customFilterConfiguration_selectAllOptions :: Lens' CustomFilterConfiguration (Maybe CategoryFilterSelectAllOptions) Source #

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

```
FILTER_ALL_VALUES
```

customFilterConfiguration_matchOperator :: Lens' CustomFilterConfiguration CategoryFilterMatchOperator Source #

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

customFilterConfiguration_nullOption :: Lens' CustomFilterConfiguration 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.