Package com.atlan.model.assets

Class FlowControlOperation

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.FlowControlOperation
All Implemented Interfaces:
IAsset, IFlow, IFlowControlOperation, IReferenceable, AuditDetail, Serializable, Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2") public class FlowControlOperation extends Asset implements IFlowControlOperation, IFlow, IAsset, IReferenceable
Execution of a single orchestrate-able unit of work.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • trimToReference

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

    • select

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

    • select

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

    • refByGuid

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

    • refByGuid

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

    • refByQualifiedName

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

    • refByQualifiedName

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

    • get

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

    • get

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

    • get

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

    • get

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

    • restore

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

    • updater

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

    • trimToRequired

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

    • removeDescription

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

    • removeUserDescription

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

    • removeOwners

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

    • updateCertificate

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

    • removeCertificate

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

    • updateAnnouncement

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

    • replaceTerms

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

    • appendTerms

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

    • removeTerms

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

    • appendAtlanTags

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

    • appendAtlanTags

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

    • _internal

      public static FlowControlOperation.FlowControlOperationBuilder<?,?> _internal()

    • toBuilder

      public FlowControlOperation.FlowControlOperationBuilder<?,?> toBuilder()
      Overrides:
      toBuilder in class Reference

    • getFlowDataResults

      public SortedSet<ILineageProcess> getFlowDataResults()
      Individual data flows (processes) orchestrated by this control operation.
      Specified by:
      getFlowDataResults in interface IFlowControlOperation

    • getFlowErrorMessage

      public String getFlowErrorMessage()
      Optional error message of the flow run.
      Specified by:
      getFlowErrorMessage in interface IFlow
      Specified by:
      getFlowErrorMessage in interface IFlowControlOperation

    • getFlowFinishedAt

      public Long getFlowFinishedAt()
      Date and time at which this point in the data processing or orchestration finished.
      Specified by:
      getFlowFinishedAt in interface IFlow
      Specified by:
      getFlowFinishedAt in interface IFlowControlOperation

    • getFlowFolderName

      public String getFlowFolderName()
      Simple name of the folder in which this asset is contained.
      Specified by:
      getFlowFolderName in interface IFlow
      Specified by:
      getFlowFolderName in interface IFlowControlOperation

    • getFlowFolderQualifiedName

      public String getFlowFolderQualifiedName()
      Unique name of the folder in which this asset is contained.
      Specified by:
      getFlowFolderQualifiedName in interface IFlow
      Specified by:
      getFlowFolderQualifiedName in interface IFlowControlOperation

    • getFlowId

      public String getFlowId()
      Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.
      Specified by:
      getFlowId in interface IFlow
      Specified by:
      getFlowId in interface IFlowControlOperation

    • getFlowProjectName

      public String getFlowProjectName()
      Simple name of the project in which this asset is contained.
      Specified by:
      getFlowProjectName in interface IFlow
      Specified by:
      getFlowProjectName in interface IFlowControlOperation

    • getFlowProjectQualifiedName

      public String getFlowProjectQualifiedName()
      Unique name of the project in which this asset is contained.
      Specified by:
      getFlowProjectQualifiedName in interface IFlow
      Specified by:
      getFlowProjectQualifiedName in interface IFlowControlOperation

    • getFlowReusableUnitName

      public String getFlowReusableUnitName()
      Simple name of the reusable grouping of operations in which this ephemeral data is contained.
      Specified by:
      getFlowReusableUnitName in interface IFlow
      Specified by:
      getFlowReusableUnitName in interface IFlowControlOperation

    • getFlowReusableUnitQualifiedName

      public String getFlowReusableUnitQualifiedName()
      Unique name of the reusable grouping of operations in which this ephemeral data is contained.
      Specified by:
      getFlowReusableUnitQualifiedName in interface IFlow
      Specified by:
      getFlowReusableUnitQualifiedName in interface IFlowControlOperation

    • getFlowRunId

      public String getFlowRunId()
      Unique ID of the flow run, which could change on subsequent runs of the same flow.
      Specified by:
      getFlowRunId in interface IFlow
      Specified by:
      getFlowRunId in interface IFlowControlOperation

    • getFlowSchedule

      public String getFlowSchedule()
      Schedule for this point in the data processing or orchestration.
      Specified by:
      getFlowSchedule in interface IFlow
      Specified by:
      getFlowSchedule in interface IFlowControlOperation

    • getFlowStartedAt

      public Long getFlowStartedAt()
      Date and time at which this point in the data processing or orchestration started.
      Specified by:
      getFlowStartedAt in interface IFlow
      Specified by:
      getFlowStartedAt in interface IFlowControlOperation

    • getFlowStatus

      public String getFlowStatus()
      Overall status of this point in the data processing or orchestration.
      Specified by:
      getFlowStatus in interface IFlow
      Specified by:
      getFlowStatus in interface IFlowControlOperation

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