Skip to content

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:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.

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
builder.mcRuleComparisonType(...); // (1)
mCRuleComparison.getMcRuleComparisonType(); // (2)

  1. Set the mcRuleComparisonType for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonType from a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

mcRuleComparisonField
Field being compared.
1
2
builder.mcRuleComparisonField(...); // (1)
mCRuleComparison.getMcRuleComparisonField(); // (2)

  1. Set the mcRuleComparisonField for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonField from a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

mcRuleComparisonMetric
Metric being compared.
1
2
builder.mcRuleComparisonMetric(...); // (1)
mCRuleComparison.getMcRuleComparisonMetric(); // (2)

  1. Set the mcRuleComparisonMetric for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonMetric from a MCRuleComparison.

    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
builder.mcRuleComparisonOperator(...); // (1)
mCRuleComparison.getMcRuleComparisonOperator(); // (2)

  1. Set the mcRuleComparisonOperator for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonOperator from a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

mcRuleComparisonThreshold
Threshold being compared.
1
2
builder.mcRuleComparisonThreshold(...); // (1)
mCRuleComparison.getMcRuleComparisonThreshold(); // (2)

  1. Set the mcRuleComparisonThreshold for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonThreshold from a MCRuleComparison.

    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
builder.mcRuleComparisonIsThresholdRelative(...); // (1)
mCRuleComparison.getMcRuleComparisonIsThresholdRelative(); // (2)

  1. Set the mcRuleComparisonIsThresholdRelative for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the mcRuleComparisonIsThresholdRelative from a MCRuleComparison.

    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
{
  "attributes": {
    "mcRuleComparisonType": ... // (1)
  }
}

  1. Set the mcRuleComparisonType for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleComparisonField
Field being compared.
1
2
3
4
5
{
  "attributes": {
    "mcRuleComparisonField": ... // (1)
  }
}

  1. Set the mcRuleComparisonField for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleComparisonMetric
Metric being compared.
1
2
3
4
5
{
  "attributes": {
    "mcRuleComparisonMetric": ... // (1)
  }
}

  1. Set the mcRuleComparisonMetric for a MCRuleComparison.

    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
{
  "attributes": {
    "mcRuleComparisonOperator": ... // (1)
  }
}

  1. Set the mcRuleComparisonOperator for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleComparisonThreshold
Threshold being compared.
1
2
3
4
5
{
  "attributes": {
    "mcRuleComparisonThreshold": ... // (1)
  }
}

  1. Set the mcRuleComparisonThreshold for a MCRuleComparison.

    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
{
  "attributes": {
    "mcRuleComparisonIsThresholdRelative": ... // (1)
  }
}

  1. Set the mcRuleComparisonIsThresholdRelative for a MCRuleComparison.

    For more details

    For more information, see the asset CRUD snippets.