Package com.atlan.model.assets

Class SAPBW

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.SAPBW
All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISAP, ISAPBW, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class SAPBW extends Asset implements ISAPBW, ISAP, ICatalog, IAsset, IReferenceable
Base class for SAP BW/4HANA assets. Inherits SAP-wide attributes (technicalName, logicalName, packageName, componentName, dataType, fieldCount, fieldOrder) so cross-SAP queries can traverse both SAP ERP and SAP BW assets. SAP BW maps componentName from RSDS.APPLNM / RSKSNEW.APPLNM.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

      public static SAPBW get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
      Retrieves a SAPBW 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 SAPBW to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SAPBW, including any relationships
      Returns:
      the requested SAPBW, 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 SAPBW does not exist or the provided GUID is not a SAPBW

    • get

      public static SAPBW get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
      Retrieves a SAPBW 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 SAPBW to retrieve, either its GUID or its full qualifiedName
      attributes - to retrieve for the SAPBW, including any relationships
      attributesOnRelated - to retrieve on each relationship retrieved for the SAPBW
      Returns:
      the requested SAPBW, 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 SAPBW does not exist or the provided GUID is not a SAPBW

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • _internal

      public static SAPBW.SAPBWBuilder<?,?> _internal()

    • toBuilder

      public SAPBW.SAPBWBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getCatalogDatasetGuid

      public String getCatalogDatasetGuid()
      Unique identifier of the dataset this asset belongs to.
      Specified by:
      getCatalogDatasetGuid in interface ICatalog
      Specified by:
      getCatalogDatasetGuid in interface ISAP
      Specified by:
      getCatalogDatasetGuid in interface ISAPBW

    • getInputToAirflowTasks

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

    • getInputToProcesses

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

    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISAP
      Specified by:
      getInputToSparkJobs in interface ISAPBW

    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface ISAP
      Specified by:
      getModelImplementedAttributes in interface ISAPBW

    • getModelImplementedEntities

      public SortedSet<IModelEntity> getModelImplementedEntities()
      Entities implemented by this asset.
      Specified by:
      getModelImplementedEntities in interface ICatalog
      Specified by:
      getModelImplementedEntities in interface ISAP
      Specified by:
      getModelImplementedEntities in interface ISAPBW

    • getOutputFromAirflowTasks

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

    • getOutputFromProcesses

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

    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISAP
      Specified by:
      getOutputFromSparkJobs in interface ISAPBW

    • getPartialChildFields

      public SortedSet<IPartialField> getPartialChildFields()
      Partial fields contained in the asset.
      Specified by:
      getPartialChildFields in interface ICatalog
      Specified by:
      getPartialChildFields in interface ISAP
      Specified by:
      getPartialChildFields in interface ISAPBW

    • getPartialChildObjects

      public SortedSet<IPartialObject> getPartialChildObjects()
      Partial objects contained in the asset.
      Specified by:
      getPartialChildObjects in interface ICatalog
      Specified by:
      getPartialChildObjects in interface ISAP
      Specified by:
      getPartialChildObjects in interface ISAPBW

    • getSapBwInfoObjectName

      public String getSapBwInfoObjectName()
      Simple name of the SAP BW InfoObject asset related to this asset.
      Specified by:
      getSapBwInfoObjectName in interface ISAPBW

    • getSapBwInfoObjectQualifiedName

      public String getSapBwInfoObjectQualifiedName()
      Unique name of the SAP BW InfoObject asset related to this asset.
      Specified by:
      getSapBwInfoObjectQualifiedName in interface ISAPBW

    • getSapBwLength

      public Long getSapBwLength()
      Length of the field in characters or bytes (e.g. RSDSSEGFD.LENG, RSKSFIELDNEW.LENG).
      Specified by:
      getSapBwLength in interface ISAPBW

    • getSapBwObjectStatus

      public String getSapBwObjectStatus()
      Lifecycle status of the object in SAP BW such as active, inactive, or modified (e.g. RSDAREA.OBJSTAT, RSKSNEW.OBJSTAT).
      Specified by:
      getSapBwObjectStatus in interface ISAPBW

    • getSapBwParentName

      public String getSapBwParentName()
      Simple name of the SAP BW parent asset in which this asset exists.
      Specified by:
      getSapBwParentName in interface ISAPBW

    • getSapBwParentQualifiedName

      public String getSapBwParentQualifiedName()
      Unique name of the SAP BW parent asset in which this asset exists.
      Specified by:
      getSapBwParentQualifiedName in interface ISAPBW

    • getSapComponentName

      public String getSapComponentName()
      Name of the SAP component, representing a specific functional area in SAP.
      Specified by:
      getSapComponentName in interface ISAP
      Specified by:
      getSapComponentName in interface ISAPBW

    • getSapDataType

      public String getSapDataType()
      SAP-specific data types.
      Specified by:
      getSapDataType in interface ISAP
      Specified by:
      getSapDataType in interface ISAPBW

    • getSapFieldCount

      public Long getSapFieldCount()
      Represents the total number of fields, columns, or child assets present in a given SAP asset.
      Specified by:
      getSapFieldCount in interface ISAP
      Specified by:
      getSapFieldCount in interface ISAPBW

    • getSapFieldOrder

      public Integer getSapFieldOrder()
      Indicates the sequential position of a field, column, or child asset within its parent SAP asset, starting from 1.
      Specified by:
      getSapFieldOrder in interface ISAP
      Specified by:
      getSapFieldOrder in interface ISAPBW

    • getSapLogicalName

      public String getSapLogicalName()
      Logical, business-friendly identifier for SAP data objects, aligned with business terminology and concepts.
      Specified by:
      getSapLogicalName in interface ISAP
      Specified by:
      getSapLogicalName in interface ISAPBW

    • getSapPackageName

      public String getSapPackageName()
      Name of the SAP package, representing a logical grouping of related SAP data objects.
      Specified by:
      getSapPackageName in interface ISAP
      Specified by:
      getSapPackageName in interface ISAPBW

    • getSapTechnicalName

      public String getSapTechnicalName()
      Technical identifier for SAP data objects, used for integration and internal reference.
      Specified by:
      getSapTechnicalName in interface ISAP
      Specified by:
      getSapTechnicalName in interface ISAPBW

    • 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 SAPBWs.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface ICatalog
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface ISAP
      Specified by:
      getTypeName in interface ISAPBW
      Overrides:
      getTypeName in class Reference