Skip to content

MCRuleSchedule

Detailed information about the schedule for a Monte Carlo rule.

Complete reference

This is a complete reference for the MCRuleSchedule 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 MCRuleSchedule struct in an asset:

mcRuleScheduleType
Type of schedule for the rule, for example dynamic or manual.
1
2
builder.mcRuleScheduleType(...); // (1)
mCRuleSchedule.getMcRuleScheduleType(); // (2)

  1. Set the mcRuleScheduleType for a MCRuleSchedule.

    For more details

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

  2. Retrieve the mcRuleScheduleType from a MCRuleSchedule.

    For more details

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

mcRuleScheduleIntervalInMinutes
How often the monitor should run, in minutes.
1
2
builder.mcRuleScheduleIntervalInMinutes(...); // (1)
mCRuleSchedule.getMcRuleScheduleIntervalInMinutes(); // (2)

  1. Set the mcRuleScheduleIntervalInMinutes for a MCRuleSchedule.

    For more details

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

  2. Retrieve the mcRuleScheduleIntervalInMinutes from a MCRuleSchedule.

    For more details

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

mcRuleScheduleStartTime
When the first execution of the rule should occur (blank means immediate).
1
2
builder.mcRuleScheduleStartTime(...); // (1)
mCRuleSchedule.getMcRuleScheduleStartTime(); // (2)

  1. Set the mcRuleScheduleStartTime for a MCRuleSchedule.

    For more details

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

  2. Retrieve the mcRuleScheduleStartTime from a MCRuleSchedule.

    For more details

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

mcRuleScheduleCrontab
Crontab for the schedule.
1
2
builder.mcRuleScheduleCrontab(...); // (1)
mCRuleSchedule.getMcRuleScheduleCrontab(); // (2)

  1. Set the mcRuleScheduleCrontab for a MCRuleSchedule.

    For more details

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

  2. Retrieve the mcRuleScheduleCrontab from a MCRuleSchedule.

    For more details

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

mcRuleScheduleType
Type of schedule for the rule, for example dynamic or manual.
1
2
3
4
5
{
  "attributes": {
    "mcRuleScheduleType": ... // (1)
  }
}

  1. Set the mcRuleScheduleType for a MCRuleSchedule.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleScheduleIntervalInMinutes
How often the monitor should run, in minutes.
1
2
3
4
5
{
  "attributes": {
    "mcRuleScheduleIntervalInMinutes": ... // (1)
  }
}

  1. Set the mcRuleScheduleIntervalInMinutes for a MCRuleSchedule.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleScheduleStartTime
When the first execution of the rule should occur (blank means immediate).
1
2
3
4
5
{
  "attributes": {
    "mcRuleScheduleStartTime": ... // (1)
  }
}

  1. Set the mcRuleScheduleStartTime for a MCRuleSchedule.

    For more details

    For more information, see the asset CRUD snippets.

mcRuleScheduleCrontab
Crontab for the schedule.
1
2
3
4
5
{
  "attributes": {
    "mcRuleScheduleCrontab": ... // (1)
  }
}

  1. Set the mcRuleScheduleCrontab for a MCRuleSchedule.

    For more details

    For more information, see the asset CRUD snippets.