Class BusinessPolicyException

All Implemented Interfaces:
IAsset, IBusinessPolicyException, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class BusinessPolicyException extends Asset implements IBusinessPolicyException, IAsset, IReferenceable
Exception to a business policy
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

      public static FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyException assets will be included.
      Returns:
      a fluent search that includes all BusinessPolicyException assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
      Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyException assets will be included.
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the assets
      Returns:
      a fluent search that includes all BusinessPolicyException assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyExceptions will be included
      Returns:
      a fluent search that includes all BusinessPolicyException assets
    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
      Start a fluent search that will return all BusinessPolicyException 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) BusinessPolicyExceptions will be included
      Returns:
      a fluent search that includes all BusinessPolicyException assets
    • refByGuid

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

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

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

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

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

      public static BusinessPolicyException get(AtlanClient client, String id) throws AtlanException
      Retrieves a BusinessPolicyException 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 BusinessPolicyException to retrieve, either its GUID or its full qualifiedName
      Returns:
      the requested full BusinessPolicyException, complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the BusinessPolicyException does not exist or the provided GUID is not a BusinessPolicyException
    • get

      public static BusinessPolicyException get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a BusinessPolicyException 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 BusinessPolicyException 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 BusinessPolicyException, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the BusinessPolicyException does not exist or the provided GUID is not a BusinessPolicyException
    • restore

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static BusinessPolicyException updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a BusinessPolicyException.
      Parameters:
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a BusinessPolicyException.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the BusinessPolicyException's announcement
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException removeAnnouncement(String qualifiedName, String name) throws AtlanException
      Remove the announcement from a BusinessPolicyException.
      Parameters:
      qualifiedName - of the BusinessPolicyException
      name - of the BusinessPolicyException
      Returns:
      the updated BusinessPolicyException, or null if the removal failed
      Throws:
      AtlanException - on any API problems
    • removeAnnouncement

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

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

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

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

      public static BusinessPolicyException appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      Link additional terms to the BusinessPolicyException, without replacing existing terms linked to the BusinessPolicyException. Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
      qualifiedName - for the BusinessPolicyException
      terms - the list of terms to append to the BusinessPolicyException
      Returns:
      the BusinessPolicyException that was updated (note that it will NOT contain details of the appended terms)
      Throws:
      AtlanException - on any API problems
    • removeTerms

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

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

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

      public static BusinessPolicyException appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException. Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
      qualifiedName - of the BusinessPolicyException
      atlanTagNames - human-readable names of the Atlan tags to add
      Returns:
      the updated BusinessPolicyException
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static BusinessPolicyException appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException. Note: this operation must make two API calls — one to retrieve the BusinessPolicyException's existing Atlan tags, and a second to append the new Atlan tags.
      Parameters:
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException
      Throws:
      AtlanException - on any API problems
    • appendAtlanTags

      public static BusinessPolicyException appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add Atlan tags to a BusinessPolicyException, without replacing existing Atlan tags linked to the BusinessPolicyException. Note: this operation must make two API calls — one to retrieve the BusinessPolicyException'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 BusinessPolicyException
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException
      Throws:
      AtlanException - on any API problems
    • removeAtlanTag

      public static void removeAtlanTag(String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a BusinessPolicyException.
      Parameters:
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException
    • removeAtlanTag

      public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from a BusinessPolicyException.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessPolicyException
      qualifiedName - of the BusinessPolicyException
      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 BusinessPolicyException
    • _internal

    • toBuilder

      Overrides:
      toBuilder in class Reference
    • getBusinessPolicyExceptionFilterDSL

      public String getBusinessPolicyExceptionFilterDSL()
      Business Policy Exception Filter ES DSL to denote the associate asset/s involved.
      Specified by:
      getBusinessPolicyExceptionFilterDSL in interface IBusinessPolicyException
    • getBusinessPolicyExceptionGroups

      public SortedSet<String> getBusinessPolicyExceptionGroups()
      List of groups who are part of this exception
      Specified by:
      getBusinessPolicyExceptionGroups in interface IBusinessPolicyException
    • getBusinessPolicyExceptionUsers

      public SortedSet<String> getBusinessPolicyExceptionUsers()
      List of users who are part of this exception
      Specified by:
      getBusinessPolicyExceptionUsers in interface IBusinessPolicyException
    • getBusinessPolicyForException

      public IBusinessPolicy getBusinessPolicyForException()
      Business policies related to exception
      Specified by:
      getBusinessPolicyForException in interface IBusinessPolicyException
    • getBusinessPolicyQualifiedName

      public String getBusinessPolicyQualifiedName()
      Unique name of the business policy through which this asset is accessible.
      Specified by:
      getBusinessPolicyQualifiedName in interface IBusinessPolicyException
    • 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 BusinessPolicyExceptions.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IBusinessPolicyException
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference