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.Evidently.Types.MetricGoal

Description

Synopsis

data MetricGoal = MetricGoal' {
- desiredChange :: Maybe ChangeDirectionEnum
- metricDefinition :: MetricDefinition
}
newMetricGoal :: MetricDefinition -> MetricGoal
metricGoal_desiredChange :: Lens' MetricGoal (Maybe ChangeDirectionEnum)
metricGoal_metricDefinition :: Lens' MetricGoal MetricDefinition

Documentation

data MetricGoal Source #

A structure that tells Evidently whether higher or lower values are desired for a metric that is used in an experiment.

See: newMetricGoal smart constructor.

Constructors

MetricGoal'
Fields desiredChange :: Maybe ChangeDirectionEnum `INCREASE` means that a variation with a higher number for this metric is performing better. `DECREASE` means that a variation with a lower number for this metric is performing better. metricDefinition :: MetricDefinition A structure that contains details about the metric.

Instances

Instances details

FromJSON MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods parseJSON :: Value -> Parser MetricGoal # parseJSONList :: Value -> Parser [MetricGoal] #
Generic MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Associated Types type Rep MetricGoal :: Type -> Type # Methods from :: MetricGoal -> Rep MetricGoal x # to :: Rep MetricGoal x -> MetricGoal #
Read MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods readsPrec :: Int -> ReadS MetricGoal # readList :: ReadS [MetricGoal] # readPrec :: ReadPrec MetricGoal # readListPrec :: ReadPrec [MetricGoal] #
Show MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods showsPrec :: Int -> MetricGoal -> ShowS # show :: MetricGoal -> String # showList :: [MetricGoal] -> ShowS #
NFData MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods rnf :: MetricGoal -> () #
Eq MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods (==) :: MetricGoal -> MetricGoal -> Bool # (/=) :: MetricGoal -> MetricGoal -> Bool #
Hashable MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal Methods hashWithSalt :: Int -> MetricGoal -> Int # hash :: MetricGoal -> Int #
type Rep MetricGoal Source #
Instance details Defined in Amazonka.Evidently.Types.MetricGoal type Rep MetricGoal = D1 ('MetaData "MetricGoal" "Amazonka.Evidently.Types.MetricGoal" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "MetricGoal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "desiredChange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChangeDirectionEnum)) :*: S1 ('MetaSel ('Just "metricDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricDefinition)))

newMetricGoal Source #

Arguments

:: MetricDefinition	`$sel:metricDefinition:MetricGoal'`
-> MetricGoal

Create a value of MetricGoal 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:desiredChange:MetricGoal', metricGoal_desiredChange - INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

$sel:metricDefinition:MetricGoal', metricGoal_metricDefinition - A structure that contains details about the metric.

metricGoal_desiredChange :: Lens' MetricGoal (Maybe ChangeDirectionEnum) Source #

INCREASE means that a variation with a higher number for this metric is performing better.

DECREASE means that a variation with a lower number for this metric is performing better.

metricGoal_metricDefinition :: Lens' MetricGoal MetricDefinition Source #

A structure that contains details about the metric.