Package com.atlan.model.assets

Class AnaplanPage

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.AnaplanPage
All Implemented Interfaces:
IAnaplan, IAnaplanPage, IAsset, IBI, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class AnaplanPage extends Asset implements IAnaplanPage, IAnaplan, IBI, ICatalog, IAsset, IReferenceable
Instances of an AnaplanPage in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

      public static AnaplanPage get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
      Retrieves a AnaplanPage 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 AnaplanPage to retrieve, either its GUID or its full qualifiedName
      includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full AnaplanPage, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AnaplanPage does not exist or the provided GUID is not a AnaplanPage

    • get

      public static AnaplanPage get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a AnaplanPage by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the AnaplanPage to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the AnaplanPage, including any relationships
      Returns:
      the requested AnaplanPage, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AnaplanPage does not exist or the provided GUID is not a AnaplanPage

    • get

      public static AnaplanPage get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a AnaplanPage by one of its identifiers, with only the requested attributes (and relationships).
      Parameters:
      client - connectivity to the Atlan tenant from which to retrieve the asset
      id - of the AnaplanPage to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the AnaplanPage, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the AnaplanPage
      Returns:
      the requested AnaplanPage, with only its minimal information and the requested attributes (and relationships)
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the AnaplanPage does not exist or the provided GUID is not a AnaplanPage

    • restore

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

    • creator

      public static AnaplanPage.AnaplanPageBuilder<?,?> creator(String name, AnaplanApp app) throws InvalidRequestException
      Builds the minimal object necessary to create a Anaplan page.
      Parameters:
      name - of the page
      app - in which the page should be created, which must have at least a qualifiedName
      Returns:
      the minimal request necessary to create the page, as a builder
      Throws:
      InvalidRequestException - if the app provided is without a qualifiedName

    • creator

      public static AnaplanPage.AnaplanPageBuilder<?,?> creator(String name, String appQualifiedName)
      Builds the minimal object necessary to create a Anaplan page.
      Parameters:
      name - of the page
      appQualifiedName - unique name of the app in which this page exists
      Returns:
      the minimal request necessary to create the page, as a builder

    • creator

      public static AnaplanPage.AnaplanPageBuilder<?,?> creator(String name, String connectionQualifiedName, String appQualifiedName)
      Builds the minimal object necessary to create a Anaplan page.
      Parameters:
      name - of the page
      connectionQualifiedName - unique name of the connection in which to create the page
      appQualifiedName - unique name of the app in which to create the page
      Returns:
      the minimal request necessary to create the page, as a builder

    • generateQualifiedName

      public static String generateQualifiedName(String name, String appQualifiedName)
      Generate a unique page name.
      Parameters:
      name - of the page
      appQualifiedName - unique name of the app in which this page exists
      Returns:
      a unique name for the page

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • _internal

      public static AnaplanPage.AnaplanPageBuilder<?,?> _internal()

    • toBuilder

      public AnaplanPage.AnaplanPageBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getAnaplanApp

      public IAnaplanApp getAnaplanApp()
      AnaplanApp asset containing this AnaplanPage.
      Specified by:
      getAnaplanApp in interface IAnaplanPage

    • getAnaplanAppQualifiedName

      public String getAnaplanAppQualifiedName()
      Unique name of the AnaplanApp asset that contains this asset.
      Specified by:
      getAnaplanAppQualifiedName in interface IAnaplanPage

    • getAnaplanModelName

      public String getAnaplanModelName()
      Simple name of the AnaplanModel asset that contains this asset(AnaplanModule and everthing under it's hierarchy).
      Specified by:
      getAnaplanModelName in interface IAnaplan
      Specified by:
      getAnaplanModelName in interface IAnaplanPage

    • getAnaplanModelQualifiedName

      public String getAnaplanModelQualifiedName()
      Unique name of the AnaplanModel asset that contains this asset(AnaplanModule and everthing under it's hierarchy).
      Specified by:
      getAnaplanModelQualifiedName in interface IAnaplan
      Specified by:
      getAnaplanModelQualifiedName in interface IAnaplanPage

    • getAnaplanModels

      public SortedSet<IAnaplanModel> getAnaplanModels()
      AnaplanModel assets contained within this AnaplanPage.
      Specified by:
      getAnaplanModels in interface IAnaplanPage

    • getAnaplanModuleName

      public String getAnaplanModuleName()
      Simple name of the AnaplanModule asset that contains this asset(AnaplanLineItem, AnaplanList, AnaplanView and everthing under their hierarchy).
      Specified by:
      getAnaplanModuleName in interface IAnaplan
      Specified by:
      getAnaplanModuleName in interface IAnaplanPage

    • getAnaplanModuleQualifiedName

      public String getAnaplanModuleQualifiedName()
      Unique name of the AnaplanModule asset that contains this asset(AnaplanLineItem, AnaplanList, AnaplanView and everthing under their hierarchy).
      Specified by:
      getAnaplanModuleQualifiedName in interface IAnaplan
      Specified by:
      getAnaplanModuleQualifiedName in interface IAnaplanPage

    • getAnaplanPageCategoryName

      public String getAnaplanPageCategoryName()
      Category Name of the AnaplanPage from the source system.
      Specified by:
      getAnaplanPageCategoryName in interface IAnaplanPage

    • getAnaplanPageType

      public String getAnaplanPageType()
      Type of the AnaplanPage from the source system.
      Specified by:
      getAnaplanPageType in interface IAnaplanPage

    • getAnaplanSourceId

      public String getAnaplanSourceId()
      Id/Guid of the Anaplan asset in the source system.
      Specified by:
      getAnaplanSourceId in interface IAnaplan
      Specified by:
      getAnaplanSourceId in interface IAnaplanPage

    • getAnaplanWorkspaceName

      public String getAnaplanWorkspaceName()
      Simple name of the AnaplanWorkspace asset that contains this asset(AnaplanModel and everthing under it's hierarchy).
      Specified by:
      getAnaplanWorkspaceName in interface IAnaplan
      Specified by:
      getAnaplanWorkspaceName in interface IAnaplanPage

    • getAnaplanWorkspaceQualifiedName

      public String getAnaplanWorkspaceQualifiedName()
      Unique name of the AnaplanWorkspace asset that contains this asset(AnaplanModel and everthing under it's hierarchy).
      Specified by:
      getAnaplanWorkspaceQualifiedName in interface IAnaplan
      Specified by:
      getAnaplanWorkspaceQualifiedName in interface IAnaplanPage

    • getInputToAirflowTasks

      public SortedSet<IAirflowTask> getInputToAirflowTasks()
      Tasks to which this asset provides input.
      Specified by:
      getInputToAirflowTasks in interface IAnaplan
      Specified by:
      getInputToAirflowTasks in interface IAnaplanPage
      Specified by:
      getInputToAirflowTasks in interface IBI
      Specified by:
      getInputToAirflowTasks in interface ICatalog

    • getInputToProcesses

      public SortedSet<ILineageProcess> getInputToProcesses()
      Processes to which this asset provides input.
      Specified by:
      getInputToProcesses in interface IAnaplan
      Specified by:
      getInputToProcesses in interface IAnaplanPage
      Specified by:
      getInputToProcesses in interface IBI
      Specified by:
      getInputToProcesses in interface ICatalog

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IAnaplan
      Specified by:
      getInputToSparkJobs in interface IAnaplanPage
      Specified by:
      getInputToSparkJobs in interface IBI
      Specified by:
      getInputToSparkJobs in interface ICatalog

    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IAnaplan
      Specified by:
      getModelImplementedAttributes in interface IAnaplanPage
      Specified by:
      getModelImplementedAttributes in interface IBI
      Specified by:
      getModelImplementedAttributes in interface ICatalog

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface IAnaplan
      Specified by:
      getModelImplementedEntities in interface IAnaplanPage
      Specified by:
      getModelImplementedEntities in interface IBI
      Specified by:
      getModelImplementedEntities in interface ICatalog

    • getOutputFromAirflowTasks

      public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
      Tasks from which this asset is output.
      Specified by:
      getOutputFromAirflowTasks in interface IAnaplan
      Specified by:
      getOutputFromAirflowTasks in interface IAnaplanPage
      Specified by:
      getOutputFromAirflowTasks in interface IBI
      Specified by:
      getOutputFromAirflowTasks in interface ICatalog

    • getOutputFromProcesses

      public SortedSet<ILineageProcess> getOutputFromProcesses()
      Processes from which this asset is produced as output.
      Specified by:
      getOutputFromProcesses in interface IAnaplan
      Specified by:
      getOutputFromProcesses in interface IAnaplanPage
      Specified by:
      getOutputFromProcesses in interface IBI
      Specified by:
      getOutputFromProcesses in interface ICatalog

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IAnaplan
      Specified by:
      getOutputFromSparkJobs in interface IAnaplanPage
      Specified by:
      getOutputFromSparkJobs in interface IBI
      Specified by:
      getOutputFromSparkJobs in interface ICatalog

    • 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 AnaplanPages.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAnaplan
      Specified by:
      getTypeName in interface IAnaplanPage
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IBI
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference