Package com.atlan.model.assets

Class SigmaPage

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.SigmaPage
All Implemented Interfaces:
IAsset, IBI, ICatalog, IReferenceable, ISigma, ISigmaPage, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class SigmaPage extends Asset implements ISigmaPage, ISigma, IBI, ICatalog, IAsset, IReferenceable
Instance of a Sigma page in Atlan.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static SigmaPage.SigmaPageBuilder<?,?> _internal()

    • toBuilder

      public SigmaPage.SigmaPageBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getApplicationContainer

      public IApplicationContainer getApplicationContainer()
      ApplicationContainer asset containing this Catalog asset.
      Specified by:
      getApplicationContainer in interface IBI
      Specified by:
      getApplicationContainer in interface ICatalog
      Specified by:
      getApplicationContainer in interface ISigma
      Specified by:
      getApplicationContainer in interface ISigmaPage

    • getAssetApplicationQualifiedName

      public String getAssetApplicationQualifiedName()
      Qualified name of the Application Container that contains this asset.
      Specified by:
      getAssetApplicationQualifiedName in interface IBI
      Specified by:
      getAssetApplicationQualifiedName in interface ICatalog
      Specified by:
      getAssetApplicationQualifiedName in interface ISigma
      Specified by:
      getAssetApplicationQualifiedName in interface ISigmaPage

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

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

    • getModelImplementedEntities

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

    • getOutputFromAirflowTasks

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

    • getOutputFromProcesses

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

    • getOutputFromSparkJobs

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

    • getSigmaDataElementCount

      public Long getSigmaDataElementCount()
      Number of data elements on this page.
      Specified by:
      getSigmaDataElementCount in interface ISigmaPage

    • getSigmaDataElementName

      public String getSigmaDataElementName()
      Simple name of the data element in which this asset exists.
      Specified by:
      getSigmaDataElementName in interface ISigma
      Specified by:
      getSigmaDataElementName in interface ISigmaPage

    • getSigmaDataElementQualifiedName

      public String getSigmaDataElementQualifiedName()
      Unique name of the data element in which this asset exists.
      Specified by:
      getSigmaDataElementQualifiedName in interface ISigma
      Specified by:
      getSigmaDataElementQualifiedName in interface ISigmaPage

    • getSigmaDataElements

      public SortedSet<ISigmaDataElement> getSigmaDataElements()
      Data elements that exist on this page.
      Specified by:
      getSigmaDataElements in interface ISigmaPage

    • getSigmaPageName

      public String getSigmaPageName()
      Simple name of the page on which this asset exists.
      Specified by:
      getSigmaPageName in interface ISigma
      Specified by:
      getSigmaPageName in interface ISigmaPage

    • getSigmaPageQualifiedName

      public String getSigmaPageQualifiedName()
      Unique name of the page on which this asset exists.
      Specified by:
      getSigmaPageQualifiedName in interface ISigma
      Specified by:
      getSigmaPageQualifiedName in interface ISigmaPage

    • getSigmaWorkbook

      public ISigmaWorkbook getSigmaWorkbook()
      Workbook in which this page exists.
      Specified by:
      getSigmaWorkbook in interface ISigmaPage

    • getSigmaWorkbookName

      public String getSigmaWorkbookName()
      Simple name of the workbook in which this asset exists.
      Specified by:
      getSigmaWorkbookName in interface ISigma
      Specified by:
      getSigmaWorkbookName in interface ISigmaPage

    • getSigmaWorkbookQualifiedName

      public String getSigmaWorkbookQualifiedName()
      Unique name of the workbook in which this asset exists.
      Specified by:
      getSigmaWorkbookQualifiedName in interface ISigma
      Specified by:
      getSigmaWorkbookQualifiedName in interface ISigmaPage

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