Package com.atlan.model.assets

Class SigmaWorkbook

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static SigmaWorkbook.SigmaWorkbookBuilder<?,?> _internal()

    • toBuilder

      public SigmaWorkbook.SigmaWorkbookBuilder<?,?> 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • getSigmaPageCount

      public Long getSigmaPageCount()
      Number of pages in this workbook.
      Specified by:
      getSigmaPageCount in interface ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • getSigmaPages

      public SortedSet<ISigmaPage> getSigmaPages()
      Pages that exist in this workbook.
      Specified by:
      getSigmaPages in interface ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 ISigmaWorkbook

    • 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 SigmaWorkbooks.
      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 ISigmaWorkbook
      Overrides:
      getTypeName in class Reference