Package com.atlan.model.assets

Class FlowReusableUnit

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.FlowReusableUnit

All Implemented Interfaces:

IAsset, IFlow, IFlowReusableUnit, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

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

A reusable grouping of data flows that will be orchestrated together as a single unit.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlowReusableUnit.FlowReusableUnitBuilder<C extends FlowReusableUnit,B extends FlowReusableUnit.FlowReusableUnitBuilder<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.IFlowReusableUnit

FLOW_ABSTRACTS, FLOW_CONTROL_OPERATION_COUNT, FLOW_DATA_FLOWS, FLOW_DATASET_COUNT, FLOW_DATASETS

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	FlowReusableUnit(FlowReusableUnit.FlowReusableUnitBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static FlowReusableUnit.FlowReusableUnitBuilder<?,?>	_internal()
static FlowReusableUnit	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List)
static FlowReusableUnit	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 FlowReusableUnit	appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static FlowReusableUnit	get(AtlanClient client, String id)	Retrieves a FlowReusableUnit by one of its identifiers, complete with all of its relationships.
static FlowReusableUnit	get(AtlanClient client, String id, boolean includeAllRelationships)	Retrieves a FlowReusableUnit by one of its identifiers, optionally complete with all of its relationships.
static FlowReusableUnit	get(AtlanClient client, String id, Collection<AtlanField> attributes)	Retrieves a FlowReusableUnit by one of its identifiers, with only the requested attributes (and relationships).
static FlowReusableUnit	get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)	Retrieves a FlowReusableUnit by one of its identifiers, with only the requested attributes (and relationships).
SortedSet<IFlowDataset>	getFlowAbstracts()	Ephemeral datasets that abstract the sub-processing carried out by the reusable unit.
Long	getFlowControlOperationCount()	Count of the number of control flow operations that execute this reusable unit.
SortedSet<IFlowDatasetOperation>	getFlowDataFlows()	Individual dataset operations contained in this reusable unit.
Long	getFlowDatasetCount()	Count of the number of ephemeral datasets contained within this reusable unit.
SortedSet<IFlowDataset>	getFlowDatasets()	Ephemeral datasets that are contained within the reusable unit.
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.
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.
String	getTypeName()	Fixed typeName for FlowReusableUnits.
int	hashCode()
static FlowReusableUnit	refByGuid(String guid)	Reference to a FlowReusableUnit by GUID.
static FlowReusableUnit	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a FlowReusableUnit by GUID.
static FlowReusableUnit	refByQualifiedName(String qualifiedName)	Reference to a FlowReusableUnit by qualifiedName.
static FlowReusableUnit	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a FlowReusableUnit by qualifiedName.
static FlowReusableUnit	removeAnnouncement(AtlanClient client, String qualifiedName, String name)	Remove the announcement from a FlowReusableUnit.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Deprecated. see Asset.AssetBuilder.removeAtlanTag(String)
static FlowReusableUnit	removeCertificate(AtlanClient client, String qualifiedName, String name)	Remove the certificate from a FlowReusableUnit.
static FlowReusableUnit	removeDescription(AtlanClient client, String qualifiedName, String name)	Remove the system description from a FlowReusableUnit.
static FlowReusableUnit	removeOwners(AtlanClient client, String qualifiedName, String name)	Remove the owners from a FlowReusableUnit.
static FlowReusableUnit	removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
static FlowReusableUnit	removeUserDescription(AtlanClient client, String qualifiedName, String name)	Remove the user's description from a FlowReusableUnit.
static FlowReusableUnit	replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)	Replace the terms linked to the FlowReusableUnit.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) FlowReusableUnit to active.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all FlowReusableUnit assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all FlowReusableUnit assets.
FlowReusableUnit.FlowReusableUnitBuilder<?,?>	toBuilder()
String	toString()
FlowReusableUnit	trimToReference()	Builds the minimal object necessary to create a relationship to a FlowReusableUnit, from a potentially more-complete FlowReusableUnit object.
FlowReusableUnit.FlowReusableUnitBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to a FlowReusableUnit, from a potentially more-complete FlowReusableUnit object.
static FlowReusableUnit	updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)	Update the announcement on a FlowReusableUnit.
static FlowReusableUnit	updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)	Update the certificate on a FlowReusableUnit.
static FlowReusableUnit.FlowReusableUnitBuilder<?,?>	updater(String qualifiedName, String name)	Builds the minimal object necessary to update a FlowReusableUnit.

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.IFlowReusableUnit

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

FlowReusableUnit

protected FlowReusableUnit(FlowReusableUnit.FlowReusableUnitBuilder<?,?> b)

Method Details

trimToReference

public FlowReusableUnit trimToReference()
                                 throws InvalidRequestException

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

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the FlowReusableUnit

Throws:

InvalidRequestException - if any of the minimal set of required properties for a FlowReusableUnit relationship are not found in the initial object

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)

Start a fluent search that will return all FlowReusableUnit 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) FlowReusableUnit assets will be included.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the assets

Returns:

a fluent search that includes all FlowReusableUnit assets

select

public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client,
 boolean includeArchived)

Start a fluent search that will return all FlowReusableUnit 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) FlowReusableUnits will be included

Returns:

a fluent search that includes all FlowReusableUnit assets

refByGuid

public static FlowReusableUnit refByGuid(String guid)

Reference to a FlowReusableUnit by GUID. Use this to create a relationship to this FlowReusableUnit, where the relationship should be replaced.

Parameters:

guid - the GUID of the FlowReusableUnit to reference

Returns:

reference to a FlowReusableUnit that can be used for defining a relationship to a FlowReusableUnit

refByGuid

public static FlowReusableUnit refByGuid(String guid,
 Reference.SaveSemantic semantic)

Reference to a FlowReusableUnit by GUID. Use this to create a relationship to this FlowReusableUnit, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

guid - the GUID of the FlowReusableUnit to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a FlowReusableUnit that can be used for defining a relationship to a FlowReusableUnit

refByQualifiedName

public static FlowReusableUnit refByQualifiedName(String qualifiedName)

Reference to a FlowReusableUnit by qualifiedName. Use this to create a relationship to this FlowReusableUnit, where the relationship should be replaced.

Parameters:

qualifiedName - the qualifiedName of the FlowReusableUnit to reference

Returns:

reference to a FlowReusableUnit that can be used for defining a relationship to a FlowReusableUnit

refByQualifiedName

public static FlowReusableUnit refByQualifiedName(String qualifiedName,
 Reference.SaveSemantic semantic)

Reference to a FlowReusableUnit by qualifiedName. Use this to create a relationship to this FlowReusableUnit, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).

Parameters:

qualifiedName - the qualifiedName of the FlowReusableUnit to reference

semantic - how to save this relationship (replace all with this, append it, or remove it)

Returns:

reference to a FlowReusableUnit that can be used for defining a relationship to a FlowReusableUnit

get

public static FlowReusableUnit get(AtlanClient client,
 String id)
                            throws AtlanException

Retrieves a FlowReusableUnit 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 FlowReusableUnit to retrieve, either its GUID or its full qualifiedName

Returns:

the requested full FlowReusableUnit, complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the FlowReusableUnit does not exist or the provided GUID is not a FlowReusableUnit

get

public static FlowReusableUnit get(AtlanClient client,
 String id,
 boolean includeAllRelationships)
                            throws AtlanException

Retrieves a FlowReusableUnit 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 FlowReusableUnit 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 FlowReusableUnit, optionally complete with all of its relationships

Throws:

AtlanException - on any error during the API invocation, such as the NotFoundException if the FlowReusableUnit does not exist or the provided GUID is not a FlowReusableUnit

get

public static FlowReusableUnit get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes)
                            throws AtlanException

Retrieves a FlowReusableUnit 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 FlowReusableUnit to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the FlowReusableUnit, including any relationships

Returns:

the requested FlowReusableUnit, 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 FlowReusableUnit does not exist or the provided GUID is not a FlowReusableUnit

get

public static FlowReusableUnit get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes,
 Collection<AtlanField> attributesOnRelated)
                            throws AtlanException

Retrieves a FlowReusableUnit 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 FlowReusableUnit to retrieve, either its GUID or its full qualifiedName

attributes - to retrieve for the FlowReusableUnit, including any relationships

attributesOnRelated - to retrieve on each relationship retrieved for the FlowReusableUnit

Returns:

the requested FlowReusableUnit, 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 FlowReusableUnit does not exist or the provided GUID is not a FlowReusableUnit

restore

public static boolean restore(AtlanClient client,
 String qualifiedName)
                       throws AtlanException

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

Parameters:

client - connectivity to the Atlan tenant on which to restore the asset

qualifiedName - for the FlowReusableUnit

Returns:

true if the FlowReusableUnit is now active, and false otherwise

Throws:

AtlanException - on any API problems

updater

public static FlowReusableUnit.FlowReusableUnitBuilder<?,?> updater(String qualifiedName,
 String name)

Builds the minimal object necessary to update a FlowReusableUnit.

Parameters:

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the minimal request necessary to update the FlowReusableUnit, as a builder

trimToRequired

public FlowReusableUnit.FlowReusableUnitBuilder<?,?> trimToRequired()
                                                             throws InvalidRequestException

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

Overrides:

trimToRequired in class Asset

Returns:

the minimal object necessary to update the FlowReusableUnit, as a builder

Throws:

InvalidRequestException - if any of the minimal set of required properties for FlowReusableUnit are not found in the initial object

removeDescription

public static FlowReusableUnit removeDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                          throws AtlanException

Remove the system description from a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the updated FlowReusableUnit, or null if the removal failed

Throws:

AtlanException - on any API problems

removeUserDescription

public static FlowReusableUnit removeUserDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                              throws AtlanException

Remove the user's description from a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the updated FlowReusableUnit, or null if the removal failed

Throws:

AtlanException - on any API problems

removeOwners

public static FlowReusableUnit removeOwners(AtlanClient client,
 String qualifiedName,
 String name)
                                     throws AtlanException

Remove the owners from a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant from which to remove the FlowReusableUnit's owners

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the updated FlowReusableUnit, or null if the removal failed

Throws:

AtlanException - on any API problems

updateCertificate

public static FlowReusableUnit updateCertificate(AtlanClient client,
 String qualifiedName,
 CertificateStatus certificate,
 String message)
                                          throws AtlanException

Update the certificate on a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant on which to update the FlowReusableUnit's certificate

qualifiedName - of the FlowReusableUnit

certificate - to use

message - (optional) message, or null if no message

Returns:

the updated FlowReusableUnit, or null if the update failed

Throws:

AtlanException - on any API problems

removeCertificate

public static FlowReusableUnit removeCertificate(AtlanClient client,
 String qualifiedName,
 String name)
                                          throws AtlanException

Remove the certificate from a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant from which to remove the FlowReusableUnit's certificate

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the updated FlowReusableUnit, or null if the removal failed

Throws:

AtlanException - on any API problems

updateAnnouncement

public static FlowReusableUnit updateAnnouncement(AtlanClient client,
 String qualifiedName,
 AtlanAnnouncementType type,
 String title,
 String message)
                                           throws AtlanException

Update the announcement on a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant on which to update the FlowReusableUnit's announcement

qualifiedName - of the FlowReusableUnit

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 FlowReusableUnit removeAnnouncement(AtlanClient client,
 String qualifiedName,
 String name)
                                           throws AtlanException

Remove the announcement from a FlowReusableUnit.

Parameters:

client - connectivity to the Atlan client from which to remove the FlowReusableUnit's announcement

qualifiedName - of the FlowReusableUnit

name - of the FlowReusableUnit

Returns:

the updated FlowReusableUnit, or null if the removal failed

Throws:

AtlanException - on any API problems

replaceTerms

public static FlowReusableUnit replaceTerms(AtlanClient client,
 String qualifiedName,
 String name,
 List<IGlossaryTerm> terms)
                                     throws AtlanException

Replace the terms linked to the FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant on which to replace the FlowReusableUnit's assigned terms

qualifiedName - for the FlowReusableUnit

name - human-readable name of the FlowReusableUnit

terms - the list of terms to replace on the FlowReusableUnit, or null to remove all terms from the FlowReusableUnit

Returns:

the FlowReusableUnit that was updated (note that it will NOT contain details of the replaced terms)

Throws:

AtlanException - on any API problems

appendTerms

@Deprecated
public static FlowReusableUnit appendTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                                    throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

Link additional terms to the FlowReusableUnit, without replacing existing terms linked to the FlowReusableUnit. Note: this operation must make two API calls — one to retrieve the FlowReusableUnit'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 FlowReusableUnit

qualifiedName - for the FlowReusableUnit

terms - the list of terms to append to the FlowReusableUnit

Returns:

the FlowReusableUnit that was updated (note that it will NOT contain details of the appended terms)

Throws:

AtlanException - on any API problems

removeTerms

@Deprecated
public static FlowReusableUnit removeTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                                    throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

Remove terms from a FlowReusableUnit, without replacing all existing terms linked to the FlowReusableUnit. Note: this operation must make two API calls — one to retrieve the FlowReusableUnit'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 FlowReusableUnit

qualifiedName - for the FlowReusableUnit

terms - the list of terms to remove from the FlowReusableUnit, which must be referenced by GUID

Returns:

the FlowReusableUnit that was updated (note that it will NOT contain details of the resulting terms)

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static FlowReusableUnit appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames)
                                        throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List)

Add Atlan tags to a FlowReusableUnit, without replacing existing Atlan tags linked to the FlowReusableUnit. Note: this operation must make two API calls — one to retrieve the FlowReusableUnit'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 FlowReusableUnit

qualifiedName - of the FlowReusableUnit

atlanTagNames - human-readable names of the Atlan tags to add

Returns:

the updated FlowReusableUnit

Throws:

AtlanException - on any API problems

appendAtlanTags

@Deprecated
public static FlowReusableUnit 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 FlowReusableUnit, without replacing existing Atlan tags linked to the FlowReusableUnit. Note: this operation must make two API calls — one to retrieve the FlowReusableUnit'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 FlowReusableUnit

qualifiedName - of the FlowReusableUnit

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 FlowReusableUnit

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 FlowReusableUnit.

Parameters:

client - connectivity to the Atlan tenant from which to remove an Atlan tag from a FlowReusableUnit

qualifiedName - of the FlowReusableUnit

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 FlowReusableUnit

_internal

public static FlowReusableUnit.FlowReusableUnitBuilder<?,?> _internal()

toBuilder

public FlowReusableUnit.FlowReusableUnitBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getFlowAbstracts

public SortedSet<IFlowDataset> getFlowAbstracts()

Ephemeral datasets that abstract the sub-processing carried out by the reusable unit.

Specified by:

getFlowAbstracts in interface IFlowReusableUnit

getFlowControlOperationCount

public Long getFlowControlOperationCount()

Count of the number of control flow operations that execute this reusable unit.

Specified by:

getFlowControlOperationCount in interface IFlowReusableUnit

getFlowDataFlows

public SortedSet<IFlowDatasetOperation> getFlowDataFlows()

Individual dataset operations contained in this reusable unit.

Specified by:

getFlowDataFlows in interface IFlowReusableUnit

getFlowDatasetCount

public Long getFlowDatasetCount()

Count of the number of ephemeral datasets contained within this reusable unit.

Specified by:

getFlowDatasetCount in interface IFlowReusableUnit

getFlowDatasets

public SortedSet<IFlowDataset> getFlowDatasets()

Ephemeral datasets that are contained within the reusable unit.

Specified by:

getFlowDatasets in interface IFlowReusableUnit

getFlowErrorMessage

public String getFlowErrorMessage()

Optional error message of the flow run.

Specified by:

getFlowErrorMessage in interface IFlow

Specified by:

getFlowErrorMessage in interface IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 IFlowReusableUnit

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 FlowReusableUnits.

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface IFlow

Specified by:

getTypeName in interface IFlowReusableUnit

Specified by:

getTypeName in interface IReferenceable

Overrides:

getTypeName in class Reference