MCRuleComparison¶
Detailed information about the comparison logic of a Monte Carlo rule.
Complete reference
This is a complete reference for the MCRuleComparison
struct in Atlan, showing all of its embedded properties. For an introduction, you probably want to start with:
Embedded properties¶
These are the attributes embedded within each instance of the MCRuleComparison
struct in an asset:
mcRuleComparisonType
Type of comparison, for example threshold. | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonType
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonType
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonField
Field being compared. | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonField
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonField
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonMetric
Metric being compared. | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonMetric
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonMetric
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonOperator
Operator used for the comparison, for example greater than (GT). | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonOperator
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonOperator
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonThreshold
Threshold being compared. | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonThreshold
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonThreshold
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonIsThresholdRelative
Whether the threshold comparison is relative (true) or absolute (false). | |
---|---|
1 2 |
|
-
Set the
mcRuleComparisonIsThresholdRelative
for aMCRuleComparison
. -
Retrieve the
mcRuleComparisonIsThresholdRelative
from aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
mcRuleComparisonType
Type of comparison, for example threshold. | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonType
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.
mcRuleComparisonField
Field being compared. | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonField
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.
mcRuleComparisonMetric
Metric being compared. | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonMetric
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.
mcRuleComparisonOperator
Operator used for the comparison, for example greater than (GT). | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonOperator
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.
mcRuleComparisonThreshold
Threshold being compared. | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonThreshold
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.
mcRuleComparisonIsThresholdRelative
Whether the threshold comparison is relative (true) or absolute (false). | |
---|---|
1 2 3 4 5 |
|
-
Set the
mcRuleComparisonIsThresholdRelative
for aMCRuleComparison
.For more details
For more information, see the asset CRUD snippets.