Class FabricDataflow

All Implemented Interfaces:
IAsset, IBI, ICatalog, IFabric, IFabricDataflow, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class FabricDataflow extends Asset implements IFabricDataflow, IFabric, IBI, ICatalog, IAsset, IReferenceable
Instance of a Microsoft Fabric dataflow in Atlan.
See Also:
  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

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

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

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

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

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

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

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

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

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

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

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

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

      Builds the minimal object necessary to apply an update to a FabricDataflow, from a potentially more-complete FabricDataflow object.
      Overrides:
      trimToRequired in class Asset
      Returns:
      the minimal object necessary to update the FabricDataflow, as a builder
      Throws:
      InvalidRequestException - if any of the minimal set of required properties for FabricDataflow are not found in the initial object
    • removeDescription

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

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

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

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

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

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

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

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

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

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

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

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

      public static FabricDataflow.FabricDataflowBuilder<?,?> _internal()
    • toBuilder

      public FabricDataflow.FabricDataflowBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference
    • getFabricColumnCount

      public Integer getFabricColumnCount()
      Number of columns in this asset.
      Specified by:
      getFabricColumnCount in interface IFabric
      Specified by:
      getFabricColumnCount in interface IFabricDataflow
    • getFabricDataType

      public String getFabricDataType()
      Data type of this asset.
      Specified by:
      getFabricDataType in interface IFabric
      Specified by:
      getFabricDataType in interface IFabricDataflow
    • getFabricDataflowEntityColumns

      public SortedSet<IFabricDataflowEntityColumn> getFabricDataflowEntityColumns()
      Individual dataflow entity columns contained in the dataflow.
      Specified by:
      getFabricDataflowEntityColumns in interface IFabricDataflow
    • getFabricOrdinal

      public Integer getFabricOrdinal()
      Order/position of this asset within its parent.
      Specified by:
      getFabricOrdinal in interface IFabric
      Specified by:
      getFabricOrdinal in interface IFabricDataflow
    • getFabricWorkspace

      public IFabricWorkspace getFabricWorkspace()
      Workspace containing the dataflow.
      Specified by:
      getFabricWorkspace in interface IFabricDataflow
    • 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 IFabric
      Specified by:
      getInputToAirflowTasks in interface IFabricDataflow
    • 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 IFabric
      Specified by:
      getInputToProcesses in interface IFabricDataflow
    • getInputToSparkJobs

      public SortedSet<ISparkJob> getInputToSparkJobs()
      TBC
      Specified by:
      getInputToSparkJobs in interface IBI
      Specified by:
      getInputToSparkJobs in interface ICatalog
      Specified by:
      getInputToSparkJobs in interface IFabric
      Specified by:
      getInputToSparkJobs in interface IFabricDataflow
    • getModelImplementedAttributes

      public SortedSet<IModelAttribute> getModelImplementedAttributes()
      Attributes implemented by this asset.
      Specified by:
      getModelImplementedAttributes in interface IBI
      Specified by:
      getModelImplementedAttributes in interface ICatalog
      Specified by:
      getModelImplementedAttributes in interface IFabric
      Specified by:
      getModelImplementedAttributes in interface IFabricDataflow
    • 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 IFabric
      Specified by:
      getModelImplementedEntities in interface IFabricDataflow
    • 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 IFabric
      Specified by:
      getOutputFromAirflowTasks in interface IFabricDataflow
    • 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 IFabric
      Specified by:
      getOutputFromProcesses in interface IFabricDataflow
    • getOutputFromSparkJobs

      public SortedSet<ISparkJob> getOutputFromSparkJobs()
      TBC
      Specified by:
      getOutputFromSparkJobs in interface IBI
      Specified by:
      getOutputFromSparkJobs in interface ICatalog
      Specified by:
      getOutputFromSparkJobs in interface IFabric
      Specified by:
      getOutputFromSparkJobs in interface IFabricDataflow
    • 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 FabricDataflows.
      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 IFabric
      Specified by:
      getTypeName in interface IFabricDataflow
      Specified by:
      getTypeName in interface IReferenceable
      Overrides:
      getTypeName in class Reference