Package com.atlan.model.assets

Class Workflow

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.Workflow
All Implemented Interfaces:
IAsset, IReferenceable, IWorkflow, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class Workflow extends Asset implements IWorkflow, IAsset, IReferenceable
Instance of a governance workflow.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • select

      public static FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all Workflow assets. Additional conditions can be chained onto the returned search before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) Workflows will be included
      Returns:
      a fluent search that includes all Workflow assets

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

      public static Workflow get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
      Retrieves a Workflow 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 Workflow to retrieve, either its GUID or its full qualifiedName
      includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
      Returns:
      the requested full Workflow, optionally complete with all of its relationships
      Throws:
      AtlanException - on any error during the API invocation, such as the NotFoundException if the Workflow does not exist or the provided GUID is not a Workflow

    • restore

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeDescription

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

    • removeUserDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • removeOwners

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

    • updateCertificate

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

    • updateCertificate

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

    • removeCertificate

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

    • removeCertificate

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

    • updateAnnouncement

      public static Workflow updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
      Update the announcement on a Workflow.
      Parameters:
      qualifiedName - of the Workflow
      type - type of announcement to set
      title - (optional) title of the announcement to set (or null for no title)
      message - (optional) message of the announcement to set (or null for no message)
      Returns:
      the result of the update, or null if the update failed
      Throws:
      AtlanException - on any API problems

    • updateAnnouncement

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

    • removeAnnouncement

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

    • replaceTerms

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

    • replaceTerms

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

    • appendTerms

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

    • appendTerms

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

    • removeTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • removeAtlanTag

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

    • removeAtlanTag

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

    • _internal

      public static Workflow.WorkflowBuilder<?,?> _internal()

    • toBuilder

      public Workflow.WorkflowBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getWorkflowConfig

      public String getWorkflowConfig()
      Details of the workflow.
      Specified by:
      getWorkflowConfig in interface IWorkflow

    • getWorkflowCreatedBy

      public String getWorkflowCreatedBy()
      Username of the user who created this workflow.
      Specified by:
      getWorkflowCreatedBy in interface IWorkflow

    • getWorkflowDeletedAt

      public Long getWorkflowDeletedAt()
      Deletion time of this workflow.
      Specified by:
      getWorkflowDeletedAt in interface IWorkflow

    • getWorkflowRunExpiresIn

      public String getWorkflowRunExpiresIn()
      Time duration after which a run of this workflow will expire.
      Specified by:
      getWorkflowRunExpiresIn in interface IWorkflow

    • getWorkflowStatus

      public WorkflowStatus getWorkflowStatus()
      Status of the workflow.
      Specified by:
      getWorkflowStatus in interface IWorkflow

    • getWorkflowTemplateGuid

      public String getWorkflowTemplateGuid()
      GUID of the workflow template from which this workflow was created.
      Specified by:
      getWorkflowTemplateGuid in interface IWorkflow

    • getWorkflowType

      public WorkflowType getWorkflowType()
      Type of the workflow.
      Specified by:
      getWorkflowType in interface IWorkflow

    • getWorkflowUpdatedBy

      public String getWorkflowUpdatedBy()
      Username of the user who updated this workflow.
      Specified by:
      getWorkflowUpdatedBy in interface IWorkflow

    • 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 Workflows.
      Specified by:
      getTypeName in interface AuditDetail
      Specified by:
      getTypeName in interface IAsset
      Specified by:
      getTypeName in interface IReferenceable
      Specified by:
      getTypeName in interface IWorkflow
      Overrides:
      getTypeName in class Reference