/AWS1/CL_EVYMETRICDEFNCONFIG¶
This structure defines a metric that you want to use to evaluate the variations during a launch or experiment.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/EVYCWDIMENSIONSAFENAME /AWS1/EVYCWDIMENSIONSAFENAME¶
A name for the metric.
IV_ENTITYIDKEY TYPE /AWS1/EVYJSONPATH /AWS1/EVYJSONPATH¶
The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is
userDetails.userID.
IV_VALUEKEY TYPE /AWS1/EVYJSONPATH /AWS1/EVYJSONPATH¶
The value that is tracked to produce the metric.
Optional arguments:¶
IV_EVENTPATTERN TYPE /AWS1/EVYJSONVALUE /AWS1/EVYJSONVALUE¶
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
IV_UNITLABEL TYPE /AWS1/EVYMETRICUNITLABEL /AWS1/EVYMETRICUNITLABEL¶
A label for the units that the metric is measuring.
Queryable Attributes¶
name¶
A name for the metric.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
entityIdKey¶
The entity, such as a user or session, that does an action that causes a metric value to be recorded. An example is
userDetails.userID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENTITYIDKEY() |
Getter for ENTITYIDKEY, with configurable default |
ASK_ENTITYIDKEY() |
Getter for ENTITYIDKEY w/ exceptions if field has no value |
HAS_ENTITYIDKEY() |
Determine if ENTITYIDKEY has a value |
valueKey¶
The value that is tracked to produce the metric.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VALUEKEY() |
Getter for VALUEKEY, with configurable default |
ASK_VALUEKEY() |
Getter for VALUEKEY w/ exceptions if field has no value |
HAS_VALUEKEY() |
Determine if VALUEKEY has a value |
eventPattern¶
The EventBridge event pattern that defines how the metric is recorded.
For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTPATTERN() |
Getter for EVENTPATTERN, with configurable default |
ASK_EVENTPATTERN() |
Getter for EVENTPATTERN w/ exceptions if field has no value |
HAS_EVENTPATTERN() |
Determine if EVENTPATTERN has a value |
unitLabel¶
A label for the units that the metric is measuring.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UNITLABEL() |
Getter for UNITLABEL, with configurable default |
ASK_UNITLABEL() |
Getter for UNITLABEL w/ exceptions if field has no value |
HAS_UNITLABEL() |
Determine if UNITLABEL has a value |