com.atlan.model.assets.FlowFolder

All Implemented Interfaces:: IAsset, IFlow, IFlowFolder, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class FlowFolder extends Asset implements IFlowFolder, IFlow, IAsset, IReferenceable

A grouping mechanism within a project to further organize data processing.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

FlowFolder.FlowFolderBuilder<C extends FlowFolder,B extends FlowFolder.FlowFolderBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset
Asset.AssetBuilder<C extends Asset,B extends Asset.AssetBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference
Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>, Reference.SaveSemantic

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject
AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>
Field Summary

Fields

Modifier and Type

Field

Description

static final String

TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject
rawJsonObject

Fields inherited from interface com.atlan.model.assets.IAsset
ADMIN_GROUPS, ADMIN_ROLES, ADMIN_USERS, ANNOUNCEMENT_MESSAGE, ANNOUNCEMENT_TITLE, ANNOUNCEMENT_TYPE, ANNOUNCEMENT_UPDATED_AT, ANNOUNCEMENT_UPDATED_BY, ANOMALO_CHECKS, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, ASSET_ANOMALO_APPLIED_CHECK_TYPES, ASSET_ANOMALO_CHECK_COUNT, ASSET_ANOMALO_CHECK_STATUSES, ASSET_ANOMALO_DQ_STATUS, ASSET_ANOMALO_FAILED_CHECK_COUNT, ASSET_ANOMALO_FAILED_CHECK_TYPES, ASSET_ANOMALO_LAST_CHECK_RUN_AT, ASSET_ANOMALO_SOURCE_URL, ASSET_COVER_IMAGE, ASSET_DBT_ACCOUNT_NAME, ASSET_DBT_ALIAS, ASSET_DBT_ENVIRONMENT_DBT_VERSION, ASSET_DBT_ENVIRONMENT_NAME, ASSET_DBT_JOB_LAST_RUN, ASSET_DBT_JOB_LAST_RUN_ARTIFACT_S3PATH, ASSET_DBT_JOB_LAST_RUN_ARTIFACTS_SAVED, ASSET_DBT_JOB_LAST_RUN_CREATED_AT, ASSET_DBT_JOB_LAST_RUN_DEQUED_AT, ASSET_DBT_JOB_LAST_RUN_EXECUTED_BY_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_GIT_BRANCH, ASSET_DBT_JOB_LAST_RUN_GIT_SHA, ASSET_DBT_JOB_LAST_RUN_HAS_DOCS_GENERATED, ASSET_DBT_JOB_LAST_RUN_HAS_SOURCES_GENERATED, ASSET_DBT_JOB_LAST_RUN_NOTIFICATIONS_SENT, ASSET_DBT_JOB_LAST_RUN_OWNER_THREAD_ID, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION, ASSET_DBT_JOB_LAST_RUN_QUEUED_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION, ASSET_DBT_JOB_LAST_RUN_RUN_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_STARTED_AT, ASSET_DBT_JOB_LAST_RUN_STATUS_MESSAGE, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION, ASSET_DBT_JOB_LAST_RUN_TOTAL_DURATION_HUMANIZED, ASSET_DBT_JOB_LAST_RUN_UPDATED_AT, ASSET_DBT_JOB_LAST_RUN_URL, ASSET_DBT_JOB_NAME, ASSET_DBT_JOB_NEXT_RUN, ASSET_DBT_JOB_NEXT_RUN_HUMANIZED, ASSET_DBT_JOB_SCHEDULE, ASSET_DBT_JOB_SCHEDULE_CRON_HUMANIZED, ASSET_DBT_JOB_STATUS, ASSET_DBT_META, ASSET_DBT_PACKAGE_NAME, ASSET_DBT_PROJECT_NAME, ASSET_DBT_SEMANTIC_LAYER_PROXY_URL, ASSET_DBT_SOURCE_FRESHNESS_CRITERIA, ASSET_DBT_TAGS, ASSET_DBT_TEST_STATUS, ASSET_DBT_UNIQUE_ID, ASSET_DBT_WORKFLOW_LAST_UPDATED, ASSET_ICON, ASSET_MC_ALERT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_NAMES, ASSET_MC_INCIDENT_PRIORITIES, ASSET_MC_INCIDENT_QUALIFIED_NAMES, ASSET_MC_INCIDENT_SEVERITIES, ASSET_MC_INCIDENT_STATES, ASSET_MC_INCIDENT_SUB_TYPES, ASSET_MC_INCIDENT_TYPES, ASSET_MC_IS_MONITORED, ASSET_MC_LAST_SYNC_RUN_AT, ASSET_MC_MONITOR_NAMES, ASSET_MC_MONITOR_QUALIFIED_NAMES, ASSET_MC_MONITOR_SCHEDULE_TYPES, ASSET_MC_MONITOR_STATUSES, ASSET_MC_MONITOR_TYPES, ASSET_POLICIES_COUNT, ASSET_POLICY_GUIDS, ASSET_REDIRECT_GUIDS, ASSET_SODA_CHECK_COUNT, ASSET_SODA_CHECK_STATUSES, ASSET_SODA_DQ_STATUS, ASSET_SODA_LAST_SCAN_AT, ASSET_SODA_LAST_SYNC_RUN_AT, ASSET_SODA_SOURCE_URL, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, FILES, HAS_CONTRACT, HAS_LINEAGE, INPUT_PORT_DATA_PRODUCTS, IS_AI_GENERATED, IS_DISCOVERABLE, IS_EDITABLE, IS_PARTIAL, LAST_ROW_CHANGED_AT, LAST_SYNC_RUN, LAST_SYNC_RUN_AT, LAST_SYNC_WORKFLOW_NAME, LEXICOGRAPHICAL_SORT_ORDER, LINKS, MC_INCIDENTS, MC_MONITORS, METRICS, NAME, NON_COMPLIANT_ASSET_POLICY_GUIDS, OUTPUT_PORT_DATA_PRODUCTS, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, QUALIFIED_NAME, README, SAMPLE_DATA_URL, SCHEMA_REGISTRY_SUBJECTS, SODA_CHECKS, SOURCE_COST_UNIT, SOURCE_CREATED_AT, SOURCE_CREATED_BY, SOURCE_EMBED_URL, SOURCE_LAST_READ_AT, SOURCE_OWNERS, SOURCE_QUERY_COMPUTE_COST_RECORDS, SOURCE_QUERY_COMPUTE_COSTS, SOURCE_READ_COUNT, SOURCE_READ_EXPENSIVE_QUERY_RECORDS, SOURCE_READ_POPULAR_QUERY_RECORDS, SOURCE_READ_QUERY_COST, SOURCE_READ_RECENT_USER_RECORDS, SOURCE_READ_RECENT_USERS, SOURCE_READ_SLOW_QUERY_RECORDS, SOURCE_READ_TOP_USER_RECORDS, SOURCE_READ_TOP_USERS, SOURCE_READ_USER_COUNT, SOURCE_TOTAL_COST, SOURCE_UPDATED_AT, SOURCE_UPDATED_BY, SOURCE_URL, STARRED_BY, STARRED_COUNT, STARRED_DETAILS, SUB_TYPE, TENANT_ID, USER_DEF_RELATIONSHIP_FROMS, USER_DEF_RELATIONSHIP_TOS, USER_DESCRIPTION, VIEW_SCORE, VIEWER_GROUPS, VIEWER_USERS

Fields inherited from interface com.atlan.model.assets.IFlow
FLOW_ERROR_MESSAGE, FLOW_FINISHED_AT, FLOW_FOLDER_NAME, FLOW_FOLDER_QUALIFIED_NAME, FLOW_ID, FLOW_PROJECT_NAME, FLOW_PROJECT_QUALIFIED_NAME, FLOW_REUSABLE_UNIT_NAME, FLOW_REUSABLE_UNIT_QUALIFIED_NAME, FLOW_RUN_ID, FLOW_SCHEDULE, FLOW_STARTED_AT, FLOW_STATUS

Fields inherited from interface com.atlan.model.assets.IFlowFolder
FLOW_PARENT_FOLDER, FLOW_SUB_FOLDERS

Fields inherited from interface com.atlan.model.assets.IReferenceable
ASSIGNED_TERMS, ATLAN_TAGS, CREATE_TIME, CREATED_BY, CUSTOM_ATTRIBUTES, GUID, PROPAGATED_ATLAN_TAGS, STATUS, SUPER_TYPE_NAMES, UPDATE_TIME, UPDATED_BY
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

FlowFolder(FlowFolder.FlowFolderBuilder<?,?> b)
Method Summary

Modifier and Type

Method

Description

static FlowFolder.FlowFolderBuilder<?,?>

_internal()

static FlowFolder

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List)

static FlowFolder

appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)

Deprecated.
see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

static FlowFolder

appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

protected boolean

canEqual(Object other)

boolean

equals(Object o)

static FlowFolder

get(AtlanClient client, String id)

Retrieves a FlowFolder by one of its identifiers, complete with all of its relationships.

static FlowFolder

get(AtlanClient client, String id, boolean includeAllRelationships)

Retrieves a FlowFolder by one of its identifiers, optionally complete with all of its relationships.

static FlowFolder

get(AtlanClient client, String id, Collection<AtlanField> attributes)

Retrieves a FlowFolder by one of its identifiers, with only the requested attributes (and relationships).

static FlowFolder

get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)

Retrieves a FlowFolder by one of its identifiers, with only the requested attributes (and relationships).

String

getFlowErrorMessage()

Optional error message of the flow run.

Long

getFlowFinishedAt()

Date and time at which this point in the data processing or orchestration finished.

String

getFlowFolderName()

Simple name of the folder in which this asset is contained.

String

getFlowFolderQualifiedName()

Unique name of the folder in which this asset is contained.

String

getFlowId()

Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.

IFlowFolder

getFlowParentFolder()

Parent folder containing the sub-folders.

String

getFlowProjectName()

Simple name of the project in which this asset is contained.

String

getFlowProjectQualifiedName()

Unique name of the project in which this asset is contained.

String

getFlowReusableUnitName()

Simple name of the reusable grouping of operations in which this ephemeral data is contained.

String

getFlowReusableUnitQualifiedName()

Unique name of the reusable grouping of operations in which this ephemeral data is contained.

String

getFlowRunId()

Unique ID of the flow run, which could change on subsequent runs of the same flow.

String

getFlowSchedule()

Schedule for this point in the data processing or orchestration.

Long

getFlowStartedAt()

Date and time at which this point in the data processing or orchestration started.

String

getFlowStatus()

Overall status of this point in the data processing or orchestration.

SortedSet<IFlowFolder>

getFlowSubFolders()

Child (sub) folders contained within the folder.

String

getTypeName()

Fixed typeName for FlowFolders.

int

hashCode()

static FlowFolder

refByGuid(String guid)

Reference to a FlowFolder by GUID.

static FlowFolder

refByGuid(String guid, Reference.SaveSemantic semantic)

Reference to a FlowFolder by GUID.

static FlowFolder

refByQualifiedName(String qualifiedName)

Reference to a FlowFolder by qualifiedName.

static FlowFolder

refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)

Reference to a FlowFolder by qualifiedName.

static FlowFolder

removeAnnouncement(AtlanClient client, String qualifiedName, String name)

Remove the announcement from a FlowFolder.

static void

removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)

Deprecated.
see Asset.AssetBuilder.removeAtlanTag(String)

static FlowFolder

removeCertificate(AtlanClient client, String qualifiedName, String name)

Remove the certificate from a FlowFolder.

static FlowFolder

removeDescription(AtlanClient client, String qualifiedName, String name)

Remove the system description from a FlowFolder.

static FlowFolder

removeOwners(AtlanClient client, String qualifiedName, String name)

Remove the owners from a FlowFolder.

static FlowFolder

removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)

Deprecated.
see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

static FlowFolder

removeUserDescription(AtlanClient client, String qualifiedName, String name)

Remove the user's description from a FlowFolder.

static FlowFolder

replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)

Replace the terms linked to the FlowFolder.

static boolean

restore(AtlanClient client, String qualifiedName)

Restore the archived (soft-deleted) FlowFolder to active.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client)

Start a fluent search that will return all FlowFolder assets.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client, boolean includeArchived)

Start a fluent search that will return all FlowFolder assets.

FlowFolder.FlowFolderBuilder<?,?>

toBuilder()

String

toString()

FlowFolder

trimToReference()

Builds the minimal object necessary to create a relationship to a FlowFolder, from a potentially more-complete FlowFolder object.

FlowFolder.FlowFolderBuilder<?,?>

trimToRequired()

Builds the minimal object necessary to apply an update to a FlowFolder, from a potentially more-complete FlowFolder object.

static FlowFolder

updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)

Update the announcement on a FlowFolder.

static FlowFolder

updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)

Update the certificate on a FlowFolder.

static FlowFolder.FlowFolderBuilder<?,?>

updater(String qualifiedName, String name)

Builds the minimal object necessary to update a FlowFolder.

Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getStatus, getSubType, getTenantId, getUpdatedBy, getUpdateTime, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, lineage, lineage, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, updateMergingCM, updateReplacingCM, updateReplacingCM

Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSemantic, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, validateRelationship, validateRequired

Methods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObject

Methods inherited from interface com.atlan.model.assets.IAsset
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IFlow
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IFlowFolder
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, getAssetAnomaloAppliedCheckTypes, getAssetAnomaloCheckCount, getAssetAnomaloCheckStatuses, getAssetAnomaloDQStatus, getAssetAnomaloFailedCheckCount, getAssetAnomaloFailedCheckTypes, getAssetAnomaloLastCheckRunAt, getAssetAnomaloSourceUrl, getAssetCoverImage, getAssetDbtAccountName, getAssetDbtAlias, getAssetDbtEnvironmentDbtVersion, getAssetDbtEnvironmentName, getAssetDbtJobLastRun, getAssetDbtJobLastRunArtifactS3Path, getAssetDbtJobLastRunArtifactsSaved, getAssetDbtJobLastRunCreatedAt, getAssetDbtJobLastRunDequedAt, getAssetDbtJobLastRunExecutedByThreadId, getAssetDbtJobLastRunGitBranch, getAssetDbtJobLastRunGitSha, getAssetDbtJobLastRunHasDocsGenerated, getAssetDbtJobLastRunHasSourcesGenerated, getAssetDbtJobLastRunNotificationsSent, getAssetDbtJobLastRunOwnerThreadId, getAssetDbtJobLastRunQueuedDuration, getAssetDbtJobLastRunQueuedDurationHumanized, getAssetDbtJobLastRunRunDuration, getAssetDbtJobLastRunRunDurationHumanized, getAssetDbtJobLastRunStartedAt, getAssetDbtJobLastRunStatusMessage, getAssetDbtJobLastRunTotalDuration, getAssetDbtJobLastRunTotalDurationHumanized, getAssetDbtJobLastRunUpdatedAt, getAssetDbtJobLastRunUrl, getAssetDbtJobName, getAssetDbtJobNextRun, getAssetDbtJobNextRunHumanized, getAssetDbtJobSchedule, getAssetDbtJobScheduleCronHumanized, getAssetDbtJobStatus, getAssetDbtMeta, getAssetDbtPackageName, getAssetDbtProjectName, getAssetDbtSemanticLayerProxyUrl, getAssetDbtSourceFreshnessCriteria, getAssetDbtTags, getAssetDbtTestStatus, getAssetDbtUniqueId, getAssetDbtWorkflowLastUpdated, getAssetIcon, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, getQualifiedName, getReadme, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSampleDataUrl, getSchemaRegistrySubjects, getSodaChecks, getSourceCostUnit, getSourceCreatedAt, getSourceCreatedBy, getSourceEmbedURL, getSourceLastReadAt, getSourceOwners, getSourceQueryComputeCostRecords, getSourceQueryComputeCosts, getSourceReadCount, getSourceReadExpensiveQueryRecords, getSourceReadPopularQueryRecords, getSourceReadQueryCost, getSourceReadRecentUserRecords, getSourceReadRecentUsers, getSourceReadSlowQueryRecords, getSourceReadTopUserRecords, getSourceReadTopUsers, getSourceReadUserCount, getSourceTotalCost, getSourceUpdatedAt, getSourceUpdatedBy, getSourceURL, getStarredBy, getStarredCount, getStarredDetails, getSubType, getTenantId, getUniqueAttributes, getUserDefRelationshipFroms, getUserDefRelationshipTos, getUserDescription, getViewerGroups, getViewerUsers, getViewScore, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedName

Methods inherited from interface com.atlan.model.assets.IReferenceable
getAtlanTagNames, getAtlanTags, getCreatedBy, getCreateTime, getCustomMetadataSets, getDeleteHandler, getGuid, getIsIncomplete, getMeaningNames, getMeanings, getPendingTasks, getQualifiedName, getStatus, getUpdatedBy, getUpdateTime

Field Details
- TYPE_NAME
  
  public static final String TYPE_NAME
  See Also:
  
  Constant Field Values
Constructor Details
- FlowFolder
  
  protected FlowFolder(FlowFolder.FlowFolderBuilder<?,?> b)
Method Details
- trimToReference
  
  public FlowFolder trimToReference() throws InvalidRequestException
  
  Builds the minimal object necessary to create a relationship to a FlowFolder, from a potentially more-complete FlowFolder object.
  
  Overrides:
  
  trimToReference in class Asset
  
  Returns:
  
  the minimal object necessary to relate to the FlowFolder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for a FlowFolder relationship are not found in the initial object
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
  
  Start a fluent search that will return all FlowFolder 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) FlowFolder assets will be included.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  Returns:
  
  a fluent search that includes all FlowFolder assets
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
  
  Start a fluent search that will return all FlowFolder 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) FlowFolders will be included
  
  Returns:
  
  a fluent search that includes all FlowFolder assets
- refByGuid
  
  public static FlowFolder refByGuid(String guid)
  
  Reference to a FlowFolder by GUID. Use this to create a relationship to this FlowFolder, where the relationship should be replaced.
  
  Parameters:
  
  guid - the GUID of the FlowFolder to reference
  
  Returns:
  
  reference to a FlowFolder that can be used for defining a relationship to a FlowFolder
- refByGuid
  
  public static FlowFolder refByGuid(String guid, Reference.SaveSemantic semantic)
  
  Reference to a FlowFolder by GUID. Use this to create a relationship to this FlowFolder, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  guid - the GUID of the FlowFolder to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a FlowFolder that can be used for defining a relationship to a FlowFolder
- refByQualifiedName
  
  public static FlowFolder refByQualifiedName(String qualifiedName)
  
  Reference to a FlowFolder by qualifiedName. Use this to create a relationship to this FlowFolder, where the relationship should be replaced.
  
  Parameters:
  
  qualifiedName - the qualifiedName of the FlowFolder to reference
  
  Returns:
  
  reference to a FlowFolder that can be used for defining a relationship to a FlowFolder
- refByQualifiedName
  
  public static FlowFolder refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
  
  Reference to a FlowFolder by qualifiedName. Use this to create a relationship to this FlowFolder, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  qualifiedName - the qualifiedName of the FlowFolder to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a FlowFolder that can be used for defining a relationship to a FlowFolder
- get
  
  public static FlowFolder get(AtlanClient client, String id) throws AtlanException
  
  Retrieves a FlowFolder 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 FlowFolder to retrieve, either its GUID or its full qualifiedName
  
  Returns:
  
  the requested full FlowFolder, complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the FlowFolder does not exist or the provided GUID is not a FlowFolder
- get
  
  public static FlowFolder get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException
  
  Retrieves a FlowFolder 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 FlowFolder 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 FlowFolder, optionally complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the FlowFolder does not exist or the provided GUID is not a FlowFolder
- get
  
  public static FlowFolder get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException
  
  Retrieves a FlowFolder 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 FlowFolder to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the FlowFolder, including any relationships
  
  Returns:
  
  the requested FlowFolder, 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 FlowFolder does not exist or the provided GUID is not a FlowFolder
- get
  
  public static FlowFolder get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException
  
  Retrieves a FlowFolder 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 FlowFolder to retrieve, either its GUID or its full qualifiedName
  
  attributes - to retrieve for the FlowFolder, including any relationships
  
  attributesOnRelated - to retrieve on each relationship retrieved for the FlowFolder
  
  Returns:
  
  the requested FlowFolder, 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 FlowFolder does not exist or the provided GUID is not a FlowFolder
- restore
  
  public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
  
  Restore the archived (soft-deleted) FlowFolder to active.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to restore the asset
  
  qualifiedName - for the FlowFolder
  
  Returns:
  
  true if the FlowFolder is now active, and false otherwise
  
  Throws:
  
  AtlanException - on any API problems
- updater
  
  public static FlowFolder.FlowFolderBuilder<?,?> updater(String qualifiedName, String name)
  
  Builds the minimal object necessary to update a FlowFolder.
  
  Parameters:
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the minimal request necessary to update the FlowFolder, as a builder
- trimToRequired
  
  public FlowFolder.FlowFolderBuilder<?,?> trimToRequired() throws InvalidRequestException
  
  Builds the minimal object necessary to apply an update to a FlowFolder, from a potentially more-complete FlowFolder object.
  
  Overrides:
  
  trimToRequired in class Asset
  
  Returns:
  
  the minimal object necessary to update the FlowFolder, as a builder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for FlowFolder are not found in the initial object
- removeDescription
  
  public static FlowFolder removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the system description from a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the updated FlowFolder, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeUserDescription
  
  public static FlowFolder removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the user's description from a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the updated FlowFolder, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeOwners
  
  public static FlowFolder removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the owners from a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the FlowFolder's owners
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the updated FlowFolder, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateCertificate
  
  public static FlowFolder updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
  
  Update the certificate on a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the FlowFolder's certificate
  
  qualifiedName - of the FlowFolder
  
  certificate - to use
  
  message - (optional) message, or null if no message
  
  Returns:
  
  the updated FlowFolder, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeCertificate
  
  public static FlowFolder removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the certificate from a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the FlowFolder's certificate
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the updated FlowFolder, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateAnnouncement
  
  public static FlowFolder updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
  
  Update the announcement on a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the FlowFolder's announcement
  
  qualifiedName - of the FlowFolder
  
  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 FlowFolder removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the announcement from a FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan client from which to remove the FlowFolder's announcement
  
  qualifiedName - of the FlowFolder
  
  name - of the FlowFolder
  
  Returns:
  
  the updated FlowFolder, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- replaceTerms
  
  public static FlowFolder replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
  
  Replace the terms linked to the FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to replace the FlowFolder's assigned terms
  
  qualifiedName - for the FlowFolder
  
  name - human-readable name of the FlowFolder
  
  terms - the list of terms to replace on the FlowFolder, or null to remove all terms from the FlowFolder
  
  Returns:
  
  the FlowFolder that was updated (note that it will NOT contain details of the replaced terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendTerms
  
  @Deprecated public static FlowFolder appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
  
  Link additional terms to the FlowFolder, without replacing existing terms linked to the FlowFolder. Note: this operation must make two API calls — one to retrieve the FlowFolder'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 FlowFolder
  
  qualifiedName - for the FlowFolder
  
  terms - the list of terms to append to the FlowFolder
  
  Returns:
  
  the FlowFolder that was updated (note that it will NOT contain details of the appended terms)
  
  Throws:
  
  AtlanException - on any API problems
- removeTerms
  
  @Deprecated public static FlowFolder removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
  
  Remove terms from a FlowFolder, without replacing all existing terms linked to the FlowFolder. Note: this operation must make two API calls — one to retrieve the FlowFolder'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 FlowFolder
  
  qualifiedName - for the FlowFolder
  
  terms - the list of terms to remove from the FlowFolder, which must be referenced by GUID
  
  Returns:
  
  the FlowFolder that was updated (note that it will NOT contain details of the resulting terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static FlowFolder appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
  
  Deprecated.
  see Asset.AssetBuilder.appendAtlanTags(List)
  
  Add Atlan tags to a FlowFolder, without replacing existing Atlan tags linked to the FlowFolder. Note: this operation must make two API calls — one to retrieve the FlowFolder'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 FlowFolder
  
  qualifiedName - of the FlowFolder
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  Returns:
  
  the updated FlowFolder
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  @Deprecated public static FlowFolder 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 FlowFolder, without replacing existing Atlan tags linked to the FlowFolder. Note: this operation must make two API calls — one to retrieve the FlowFolder'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 FlowFolder
  
  qualifiedName - of the FlowFolder
  
  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 FlowFolder
  
  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 FlowFolder.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove an Atlan tag from a FlowFolder
  
  qualifiedName - of the FlowFolder
  
  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 FlowFolder
- _internal
  
  public static FlowFolder.FlowFolderBuilder<?,?> _internal()
- toBuilder
  
  public FlowFolder.FlowFolderBuilder<?,?> toBuilder()
  
  Overrides:
  
  toBuilder in class Reference
- getFlowErrorMessage
  
  public String getFlowErrorMessage()
  
  Optional error message of the flow run.
  
  Specified by:
  
  getFlowErrorMessage in interface IFlow
  
  Specified by:
  
  getFlowErrorMessage in interface IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- getFlowParentFolder
  
  public IFlowFolder getFlowParentFolder()
  
  Parent folder containing the sub-folders.
  
  Specified by:
  
  getFlowParentFolder in interface IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- 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 IFlowFolder
- getFlowSubFolders
  
  public SortedSet<IFlowFolder> getFlowSubFolders()
  
  Child (sub) folders contained within the folder.
  
  Specified by:
  
  getFlowSubFolders in interface IFlowFolder
- 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 FlowFolders.
  
  Specified by:
  
  getTypeName in interface AuditDetail
  
  Specified by:
  
  getTypeName in interface IAsset
  
  Specified by:
  
  getTypeName in interface IFlow
  
  Specified by:
  
  getTypeName in interface IFlowFolder
  
  Specified by:
  
  getTypeName in interface IReferenceable
  
  Overrides:
  
  getTypeName in class Reference

Class FlowFolder

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.model.assets.Asset

Nested classes/interfaces inherited from class com.atlan.model.relations.Reference

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

Fields inherited from interface com.atlan.model.assets.IAsset

Fields inherited from interface com.atlan.model.assets.IFlow

Fields inherited from interface com.atlan.model.assets.IFlowFolder

Fields inherited from interface com.atlan.model.assets.IReferenceable

Constructor Summary

Method Summary

Methods inherited from class com.atlan.model.assets.Asset

Methods inherited from class com.atlan.model.relations.Reference

Methods inherited from class com.atlan.model.core.AtlanObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlan.model.search.AuditDetail

Methods inherited from interface com.atlan.model.assets.IAsset

Methods inherited from interface com.atlan.model.assets.IFlow

Methods inherited from interface com.atlan.model.assets.IFlowFolder

Methods inherited from interface com.atlan.model.assets.IReferenceable

Field Details

TYPE_NAME

Constructor Details

FlowFolder

Method Details

trimToReference

select

select

refByGuid

refByGuid

refByQualifiedName

refByQualifiedName

get

get

get

get

restore

updater

trimToRequired

removeDescription

removeUserDescription

removeOwners

updateCertificate

removeCertificate

updateAnnouncement

removeAnnouncement

replaceTerms

appendTerms

removeTerms

appendAtlanTags

appendAtlanTags

removeAtlanTag

_internal

toBuilder

getFlowErrorMessage

getFlowFinishedAt

getFlowFolderName

getFlowFolderQualifiedName

getFlowId

getFlowParentFolder

getFlowProjectName

getFlowProjectQualifiedName

getFlowReusableUnitName

getFlowReusableUnitQualifiedName

getFlowRunId

getFlowSchedule

getFlowStartedAt

getFlowStatus

getFlowSubFolders

equals

canEqual

hashCode

toString

getTypeName