Class MCMonitor

All Implemented Interfaces:
IAsset, ICatalog, IDataQuality, IMCMonitor, IMonteCarlo, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class MCMonitor extends Asset implements IMCMonitor, IMonteCarlo, IDataQuality, ICatalog, IAsset, IReferenceable
Instance of a Monte Carlo monitor in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

      public MCMonitor trimToReference() throws InvalidRequestException
      Builds the minimal object necessary to create a relationship to a MCMonitor, from a potentially more-complete MCMonitor object.
      Overrides:
      trimToReference in class Asset
      Returns:
      the minimal object necessary to relate to the MCMonitor
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for a MCMonitor relationship are not found in the initial object
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all MCMonitor assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) MCMonitor assets will be included.
      Returns:
      a fluent search that includes all MCMonitor assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all MCMonitor assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) MCMonitor assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all MCMonitor assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all MCMonitor assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) MCMonitors will be included
      Returns:
      a fluent search that includes all MCMonitor assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all MCMonitor assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      includeArchived - when true, archived (soft-deleted) MCMonitors will be included
      Returns:
      a fluent search that includes all MCMonitor assets
    • refByGuid

      public static MCMonitor refByGuid(String guid)
      Reference to a MCMonitor by GUID. Use this to create a relationship to this MCMonitor, where the relationship should be replaced.
      Parameters:
      guid - the GUID of the MCMonitor to reference
      Returns:
      reference to a MCMonitor that can be used for defining a relationship to a MCMonitor
    • refByGuid

      public static MCMonitor refByGuid(String guid, Reference.SaveSemantic semantic)
      Reference to a MCMonitor by GUID. Use this to create a relationship to this MCMonitor, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      guid - the GUID of the MCMonitor to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a MCMonitor that can be used for defining a relationship to a MCMonitor
    • refByQualifiedName

      public static MCMonitor refByQualifiedName(String qualifiedName)
      Reference to a MCMonitor by qualifiedName. Use this to create a relationship to this MCMonitor, where the relationship should be replaced.
      Parameters:
      qualifiedName - the qualifiedName of the MCMonitor to reference
      Returns:
      reference to a MCMonitor that can be used for defining a relationship to a MCMonitor
    • refByQualifiedName

      public static MCMonitor refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
      Reference to a MCMonitor by qualifiedName. Use this to create a relationship to this MCMonitor, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
      Parameters:
      qualifiedName - the qualifiedName of the MCMonitor to reference
      semantic - how to save this relationship (replace all with this, append it, or remove it)
      Returns:
      reference to a MCMonitor that can be used for defining a relationship to a MCMonitor
    • get

      public static MCMonitor get(String id) throws AtlanException
      Retrieves a MCMonitor by one of its identifiers, complete with all of its relationships.
      Parameters:
      id - of the MCMonitor to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full MCMonitor, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the MCMonitor does not exist or the provided GUID is not a MCMonitor
    • get

      public static MCMonitor get(AtlanClient client, String id) throws AtlanException
      Retrieves a MCMonitor by one of its identifiers, complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the MCMonitor to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full MCMonitor, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the MCMonitor does not exist or the provided GUID is not a MCMonitor
    • get

      public static MCMonitor get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a MCMonitor by one of its identifiers, optionally complete with all of its relationships.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the MCMonitor to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full MCMonitor, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the MCMonitor does not exist or the provided GUID is not a MCMonitor
    • restore

      public static boolean restore(String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) MCMonitor to active.
      Parameters:
      qualifiedName - for the MCMonitor
      Returns:
      true if the MCMonitor is now active, and false otherwise
      Throws:
      AtlanException - on any API problems
    • restore

      public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
      Restore the archived (soft-deleted) MCMonitor to active.
      Parameters:
      client - connectivity to the Atlan tenant on which to restore the asset
      qualifiedName - for the MCMonitor
      Returns:
      true if the MCMonitor is now active, and false otherwise
      Throws:
      AtlanException - on any API problems
    • updater

      public static MCMonitor.MCMonitorBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the minimal request necessary to update the MCMonitor, as a builder
    • trimToRequired

      public MCMonitor.MCMonitorBuilder<?,?> trimToRequired() throws InvalidRequestException
      Builds the minimal object necessary to apply an update to a MCMonitor, from a potentially more-complete MCMonitor object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the MCMonitor, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for MCMonitor are not found in the initial object
    • removeDescription

      public static MCMonitor removeDescription(String qualifiedName, String name) throws AtlanException
      Remove the system description from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeDescription

      public static MCMonitor removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the system description from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeUserDescription

      public static MCMonitor removeUserDescription(String qualifiedName, String name) throws AtlanException
      Remove the user's description from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeUserDescription

      public static MCMonitor removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the user's description from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeOwners

      public static MCMonitor removeOwners(String qualifiedName, String name) throws AtlanException
      Remove the owners from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeOwners

      public static MCMonitor removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the owners from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the MCMonitor's owners
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • updateCertificate

      public static MCMonitor updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated MCMonitor, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • updateCertificate

      public static MCMonitor updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
      Update the certificate on a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the MCMonitor's certificate
      qualifiedName - of the MCMonitor
      certificate - to use
      message - (optional) message, or null if no message
      Returns:
      the updated MCMonitor, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • removeCertificate

      public static MCMonitor removeCertificate(String qualifiedName, String name) throws AtlanException
      Remove the certificate from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeCertificate

      public static MCMonitor removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the certificate from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the MCMonitor's certificate
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • updateAnnouncement

      public static MCMonitor updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • updateAnnouncement

      public static MCMonitor updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the MCMonitor's announcement
      qualifiedName - of the MCMonitor
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems
    • removeAnnouncement

      public static MCMonitor removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeAnnouncement

      public static MCMonitor removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
      Remove the announcement from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan client from which to remove the MCMonitor's announcement
      qualifiedName - of the MCMonitor
      name - of the MCMonitor
      Returns:
      the updated MCMonitor, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • replaceTerms

      public static MCMonitor replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the MCMonitor.
      Parameters:
      qualifiedName - for the MCMonitor
      name - human-readable name of the MCMonitor
      terms - the list of terms to replace on the MCMonitor, or null to remove all terms from the MCMonitor
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems
    • replaceTerms

      public static MCMonitor replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
      Replace the terms linked to the MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the MCMonitor's assigned terms
      qualifiedName - for the MCMonitor
      name - human-readable name of the MCMonitor
      terms - the list of terms to replace on the MCMonitor, or null to remove all terms from the MCMonitor
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the replaced terms)
      Throws:
      AtlanException - on any API problems
    • appendTerms

      public static MCMonitor appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the MCMonitor, without replacing existing terms linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing terms, and a second to append the new terms.
      Parameters:
      qualifiedName - for the MCMonitor
      terms - the list of terms to append to the MCMonitor
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems
    • appendTerms

      public static MCMonitor appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the MCMonitor, without replacing existing terms linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing terms, and a second to append the new terms.
      Parameters:
      client - connectivity to the Atlan tenant on which to append terms to the MCMonitor
      qualifiedName - for the MCMonitor
      terms - the list of terms to append to the MCMonitor
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems
    • removeTerms

      public static MCMonitor removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a MCMonitor, without replacing all existing terms linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing terms, and a second to remove the provided terms.
      Parameters:
      qualifiedName - for the MCMonitor
      terms - the list of terms to remove from the MCMonitor, which must be referenced by GUID
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems
    • removeTerms

      public static MCMonitor removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Remove terms from a MCMonitor, without replacing all existing terms linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing terms, and a second to remove the provided terms.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove terms from the MCMonitor
      qualifiedName - for the MCMonitor
      terms - the list of terms to remove from the MCMonitor, which must be referenced by GUID
      Returns:
      the MCMonitor that was updated (note that it will NOT contain details of the resulting terms)
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static MCMonitor appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a MCMonitor, without replacing existing Atlan tags linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the MCMonitor
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated MCMonitor
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static MCMonitor appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a MCMonitor, without replacing existing Atlan tags linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the MCMonitor
      qualifiedName - of the MCMonitor
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated MCMonitor
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static MCMonitor appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a MCMonitor, without replacing existing Atlan tags linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the MCMonitor
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated MCMonitor
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static MCMonitor appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a MCMonitor, without replacing existing Atlan tags linked to the MCMonitor. Note: this operation must make two API calls — one to retrieve the MCMonitor's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      client - connectivity to the Atlan tenant on which to append Atlan tags to the MCMonitor
      qualifiedName - of the MCMonitor
      atlanTagNames - human-readable names of the Atlan tags to add
      propagate - whether to propagate the Atlan tag (true) or not (false)
      removePropagationsOnDelete - whether to remove the propagated Atlan tags when the Atlan tag is removed from this asset (true) or not (false)
      restrictLineagePropagation - whether to avoid propagating through lineage (true) or do propagate through lineage (false)
      Returns:
      the updated MCMonitor
      Throws:
      AtlanException - on any API problems
    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a MCMonitor.
      Parameters:
      qualifiedName - of the MCMonitor
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the MCMonitor
    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a MCMonitor.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a MCMonitor
      qualifiedName - of the MCMonitor
      atlanTagName - human-readable name of the Atlan tag to remove
      Throws:
      AtlanException - on any API problems, or if the Atlan tag does not exist on the MCMonitor
    • _internal

      public static MCMonitor.MCMonitorBuilder<?,?> _internal()
    • toBuilder

      public MCMonitor.MCMonitorBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface IDataQuality
      Specified by:
      getApplicationContainer in interface IMCMonitor
      Specified by:
      getApplicationContainer in interface IMonteCarlo
    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface IDataQuality
      Specified by:
      getAssetApplicationQualifiedName in interface IMCMonitor
      Specified by:
      getAssetApplicationQualifiedName in interface IMonteCarlo
    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface ICatalog
      Specified by:
      getInputToAirflowTasks in interface IDataQuality
      Specified by:
      getInputToAirflowTasks in interface IMCMonitor
      Specified by:
      getInputToAirflowTasks in interface IMonteCarlo
    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface ICatalog
      Specified by:
      getInputToProcesses in interface IDataQuality
      Specified by:
      getInputToProcesses in interface IMCMonitor
      Specified by:
      getInputToProcesses in interface IMonteCarlo
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IDataQuality
      Specified by:
      getInputToSparkJobs in interface IMCMonitor
      Specified by:
      getInputToSparkJobs in interface IMonteCarlo
    • getMcAssetQualifiedNames

      public SortedSet<String> getMcAssetQualifiedNames()
      List of unique names of assets that are part of this Monte Carlo asset.
      Specified by:
      getMcAssetQualifiedNames in interface IMCMonitor
      Specified by:
      getMcAssetQualifiedNames in interface IMonteCarlo
    • getMcLabels

      public SortedSet<String> getMcLabels()
      List of labels for this Monte Carlo asset.
      Specified by:
      getMcLabels in interface IMCMonitor
      Specified by:
      getMcLabels in interface IMonteCarlo
    • getMcMonitorAlertCondition

      public String getMcMonitorAlertCondition()
      Condition on which the monitor produces an alert.
      Specified by:
      getMcMonitorAlertCondition in interface IMCMonitor
    • getMcMonitorAlertCount

      public Long getMcMonitorAlertCount()
      Number of alerts associated with this monitor.
      Specified by:
      getMcMonitorAlertCount in interface IMCMonitor
    • getMcMonitorAssets

      public SortedSet<IAsset> getMcMonitorAssets()
      Assets impacted by this monitor.
      Specified by:
      getMcMonitorAssets in interface IMCMonitor
    • getMcMonitorBreachRate

      public Double getMcMonitorBreachRate()
      Rate at which this monitor is breached.
      Specified by:
      getMcMonitorBreachRate in interface IMCMonitor
    • getMcMonitorId

      public String getMcMonitorId()
      Unique identifier for this monitor, from Monte Carlo.
      Specified by:
      getMcMonitorId in interface IMCMonitor
    • getMcMonitorIncidentCount

      public Long getMcMonitorIncidentCount()
      Number of incidents associated with this monitor.
      Specified by:
      getMcMonitorIncidentCount in interface IMCMonitor
    • getMcMonitorNamespace

      public String getMcMonitorNamespace()
      Namespace of this monitor.
      Specified by:
      getMcMonitorNamespace in interface IMCMonitor
    • getMcMonitorPriority

      public String getMcMonitorPriority()
      Priority of this monitor.
      Specified by:
      getMcMonitorPriority in interface IMCMonitor
    • getMcMonitorRuleComparisons

      public List<MCRuleComparison> getMcMonitorRuleComparisons()
      Comparison logic used for the rule.
      Specified by:
      getMcMonitorRuleComparisons in interface IMCMonitor
    • getMcMonitorRuleCustomSql

      public String getMcMonitorRuleCustomSql()
      SQL code for custom SQL rules.
      Specified by:
      getMcMonitorRuleCustomSql in interface IMCMonitor
    • getMcMonitorRuleIsSnoozed

      public Boolean getMcMonitorRuleIsSnoozed()
      Whether the rule is currently snoozed (true) or not (false).
      Specified by:
      getMcMonitorRuleIsSnoozed in interface IMCMonitor
    • getMcMonitorRuleNextExecutionTime

      public Long getMcMonitorRuleNextExecutionTime()
      Time at which the next execution of the rule should occur.
      Specified by:
      getMcMonitorRuleNextExecutionTime in interface IMCMonitor
    • getMcMonitorRulePreviousExecutionTime

      public Long getMcMonitorRulePreviousExecutionTime()
      Time at which the previous execution of the rule occurred.
      Specified by:
      getMcMonitorRulePreviousExecutionTime in interface IMCMonitor
    • getMcMonitorRuleScheduleConfig

      public MCRuleSchedule getMcMonitorRuleScheduleConfig()
      Schedule details for the rule.
      Specified by:
      getMcMonitorRuleScheduleConfig in interface IMCMonitor
    • getMcMonitorRuleScheduleConfigHumanized

      public String getMcMonitorRuleScheduleConfigHumanized()
      Readable description of the schedule for the rule.
      Specified by:
      getMcMonitorRuleScheduleConfigHumanized in interface IMCMonitor
    • getMcMonitorRuleType

      public String getMcMonitorRuleType()
      Type of rule for this monitor.
      Specified by:
      getMcMonitorRuleType in interface IMCMonitor
    • getMcMonitorScheduleType

      public String getMcMonitorScheduleType()
      Type of schedule for this monitor, for example: fixed or dynamic.
      Specified by:
      getMcMonitorScheduleType in interface IMCMonitor
    • getMcMonitorStatus

      public String getMcMonitorStatus()
      Status of this monitor.
      Specified by:
      getMcMonitorStatus in interface IMCMonitor
    • getMcMonitorType

      public String getMcMonitorType()
      Type of this monitor, for example: field health (stats) or dimension tracking (categories).
      Specified by:
      getMcMonitorType in interface IMCMonitor
    • getMcMonitorWarehouse

      public String getMcMonitorWarehouse()
      Name of the warehouse for this monitor.
      Specified by:
      getMcMonitorWarehouse in interface IMCMonitor
    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface IDataQuality
      Specified by:
      getModelImplementedEntities in interface IMCMonitor
      Specified by:
      getModelImplementedEntities in interface IMonteCarlo
    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog
      Specified by:
      getOutputFromAirflowTasks in interface IDataQuality
      Specified by:
      getOutputFromAirflowTasks in interface IMCMonitor
      Specified by:
      getOutputFromAirflowTasks in interface IMonteCarlo
    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface ICatalog
      Specified by:
      getOutputFromProcesses in interface IDataQuality
      Specified by:
      getOutputFromProcesses in interface IMCMonitor
      Specified by:
      getOutputFromProcesses in interface IMonteCarlo
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IDataQuality
      Specified by:
      getOutputFromSparkJobs in interface IMCMonitor
      Specified by:
      getOutputFromSparkJobs in interface IMonteCarlo
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Asset
    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Asset
    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset
    • getTypeName

      public String getTypeName()
      Fixed typeName for MCMonitors.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IDataQuality
      Specified by:
      getTypeName in interface IMCMonitor
      Specified by:
      getTypeName in interface IMonteCarlo
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference