Package com.atlan.model.assets

Class SapErpComponent

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

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

      @Deprecated public static SapErpComponent 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 SapErpComponent, without replacing existing Atlan tags linked to the SapErpComponent. Note: this operation must make two API calls — one to retrieve the SapErpComponent'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 SapErpComponent
      qualifiedName - of the SapErpComponent
      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 SapErpComponent
      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 SapErpComponent.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove an Atlan tag from a SapErpComponent
      qualifiedName - of the SapErpComponent
      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 SapErpComponent

    • _internal

      public static SapErpComponent.SapErpComponentBuilder<?,?> _internal()

    • toBuilder

      public SapErpComponent.SapErpComponentBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getChildComponents

      public SortedSet<ISapErpComponent> getChildComponents()
      Child SAP ERP Component associated with this SAP ERP Components.
      Specified by:
      getChildComponents in interface ISapErpComponent

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

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

    • getInputToSparkJobs

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

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

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

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

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

    • getOutputFromSparkJobs

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

    • getParentComponent

      public ISapErpComponent getParentComponent()
      Parent SAP ERP Component in which these child SAP ERP Component exist.
      Specified by:
      getParentComponent in interface ISapErpComponent

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

    • getSapDataType

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

    • getSapErpAbapPrograms

      public SortedSet<ISapErpAbapProgram> getSapErpAbapPrograms()
      SAP ERP Component associated with this SAP ERP ABAP Programs.
      Specified by:
      getSapErpAbapPrograms in interface ISapErpComponent

    • getSapErpFunctionModules

      public SortedSet<ISapErpFunctionModule> getSapErpFunctionModules()
      SAP ERP Component associated with this SAP ERP Function Modules.
      Specified by:
      getSapErpFunctionModules in interface ISapErpComponent

    • getSapErpTables

      public SortedSet<ISapErpTable> getSapErpTables()
      SAP ERP Component associated with these SAP ERP Tables.
      Specified by:
      getSapErpTables in interface ISapErpComponent

    • getSapErpTransactionCodes

      public SortedSet<ISapErpTransactionCode> getSapErpTransactionCodes()
      SAP ERP Component associated with these SAP ERP Transaction Codes.
      Specified by:
      getSapErpTransactionCodes in interface ISapErpComponent

    • getSapErpViews

      public SortedSet<ISapErpView> getSapErpViews()
      SAP ERP Component associated with this SAP ERP Views.
      Specified by:
      getSapErpViews in interface ISapErpComponent

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

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

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

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

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

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