Amazonka.Rum.Types.QueryFilter

Documentation

data QueryFilter

A structure that defines a key and values that you can use to filter the results. The only performance events that are returned are those that have values matching the ones that you specify in one of your QueryFilter structures.

For example, you could specify Browser as the Name and specify Chrome,Firefox as the Values to return events generated only from those browsers.

Specifying Invert as the Name works as a "not equal to" filter. For example, specify Invert as the Name and specify Chrome as the value to return all events except events from user sessions with the Chrome browser.

See: newQueryFilter smart constructor.

Constructors

QueryFilter'

Fields

• name :: Maybe Text

  The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

  Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

• values :: Maybe [Text]

  The values of the Name that are to be be included in the returned results.

Instances

ToJSON QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

toJSON :: QueryFilter -> Value

toEncoding :: QueryFilter -> Encoding

toJSONList :: [QueryFilter] -> Value

toEncodingList :: [QueryFilter] -> Encoding

Generic QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Associated Types

type Rep QueryFilter :: Type -> Type

Methods

from :: QueryFilter -> Rep QueryFilter x

to :: Rep QueryFilter x -> QueryFilter

Read QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

readsPrec :: Int -> ReadS QueryFilter

readList :: ReadS [QueryFilter]

readPrec :: ReadPrec QueryFilter

readListPrec :: ReadPrec [QueryFilter]

Show QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

showsPrec :: Int -> QueryFilter -> ShowS

show :: QueryFilter -> String

showList :: [QueryFilter] -> ShowS

NFData QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

rnf :: QueryFilter -> ()

Eq QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

(==) :: QueryFilter -> QueryFilter -> Bool

(/=) :: QueryFilter -> QueryFilter -> Bool

Hashable QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

Methods

hashWithSalt :: Int -> QueryFilter -> Int

hash :: QueryFilter -> Int

type Rep QueryFilter

Defined in Amazonka.Rum.Types.QueryFilter

type Rep QueryFilter = D1 ('MetaData "QueryFilter" "Amazonka.Rum.Types.QueryFilter" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "QueryFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newQueryFilter :: QueryFilter

Create a value of QueryFilter 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:name:QueryFilter', queryFilter_name - The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

$sel:values:QueryFilter', queryFilter_values - The values of the Name that are to be be included in the returned results.

queryFilter_name :: Lens' QueryFilter (Maybe Text)

The name of a key to search for. The filter returns only the events that match the Name and Values that you specify.

Valid values for Name are Browser | Device | Country | Page | OS | EventType | Invert

queryFilter_values :: Lens' QueryFilter (Maybe [Text])

The values of the Name that are to be be included in the returned results.