Class SapErpView

All Implemented Interfaces:
IAsset, ICatalog, IReferenceable, ISAP, ISapErpView, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class SapErpView extends Asset implements ISapErpView, ISAP, ICatalog, IAsset, IReferenceable
Instance of a SAP table in Atlan.
See Also:
  • Field Details Link icon

  • Constructor Details Link icon

  • Method Details Link icon

    • trimToReference Link icon

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

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

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

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

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

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

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

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

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

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

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

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

      public static SapErpView.SapErpViewBuilder<?,?> updater(String qualifiedName, String name)
      Builds the minimal object necessary to update a SapErpView.
      Parameters:
      qualifiedName - of the SapErpView
      name - of the SapErpView
      Returns:
      the minimal request necessary to update the SapErpView, as a builder
    • trimToRequired Link icon

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

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

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

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

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

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

      public static SapErpView updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a SapErpView.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the SapErpView's announcement
      qualifiedName - of the SapErpView
      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 Link icon

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

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

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

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

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

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

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

      public static SapErpView.SapErpViewBuilder<?,?> _internal()
    • toBuilder Link icon

      public SapErpView.SapErpViewBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getInputToAirflowTasks Link icon

      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 ISapErpView
    • getInputToProcesses Link icon

      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 ISapErpView
    • getInputToSparkJobs Link icon

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface ISAP
      Specified by:
      getInputToSparkJobs in interface ISapErpView
    • getModelImplementedAttributes Link icon

      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 ISapErpView
    • getModelImplementedEntities Link icon

      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 ISapErpView
    • getOutputFromAirflowTasks Link icon

      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 ISapErpView
    • getOutputFromProcesses Link icon

      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 ISapErpView
    • getOutputFromSparkJobs Link icon

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface ISAP
      Specified by:
      getOutputFromSparkJobs in interface ISapErpView
    • getSapComponentName Link icon

      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 ISapErpView
    • getSapDataType Link icon

      public String getSapDataType()
      SAP-specific data types
      Specified by:
      getSapDataType in interface ISAP
      Specified by:
      getSapDataType in interface ISapErpView
    • getSapErpColumns Link icon

      public SortedSet<ISapErpColumn> getSapErpColumns()
      SAP ERP Columns that exist within this view.
      Specified by:
      getSapErpColumns in interface ISapErpView
    • getSapErpComponent Link icon

      public ISapErpComponent getSapErpComponent()
      SAP ERP Views that are associated with this SAP ERP Component.
      Specified by:
      getSapErpComponent in interface ISapErpView
    • getSapErpViewDefinition Link icon

      public String getSapErpViewDefinition()
      Specifies the definition of the SAP ERP View
      Specified by:
      getSapErpViewDefinition in interface ISapErpView
    • getSapErpViewType Link icon

      public String getSapErpViewType()
      Type of the SAP ERP View.
      Specified by:
      getSapErpViewType in interface ISapErpView
    • getSapFieldCount Link icon

      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 ISapErpView
    • getSapFieldOrder Link icon

      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 ISapErpView
    • getSapLogicalName Link icon

      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 ISapErpView
    • getSapPackageName Link icon

      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 ISapErpView
    • getSapTechnicalName Link icon

      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 ISapErpView
    • equals Link icon

      public boolean equals(Object o)
      Overrides:
      equals in class Asset
    • canEqual Link icon

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Asset
    • hashCode Link icon

      public int hashCode()
      Overrides:
      hashCode in class Asset
    • toString Link icon

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Asset
    • getTypeName Link icon

      public String getTypeName()
      Fixed typeName for SapErpViews.
      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 ISapErpView
      Overrides:
      getTypeName in class Reference