Package com.atlan.model.assets
Class FlowDataset
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.FlowDataset
- All Implemented Interfaces:
IAsset
,ICatalog
,IFlow
,IFlowDataset
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class FlowDataset
extends Asset
implements IFlowDataset, ICatalog, IFlow, IAsset, IReferenceable
An ephemeral piece of data either produced by or used as input by a data operation.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
FlowDataset.FlowDatasetBuilder<C extends FlowDataset,
B extends FlowDataset.FlowDatasetBuilder<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
FieldsFields 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.ICatalog
INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS
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.IFlowDataset
FLOW_DETAILED_BY, FLOW_EXPRESSION, FLOW_FIELD_COUNT, FLOW_FIELDS, FLOW_PARENT_UNIT, FLOW_QUERY, FLOW_TYPE
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 -
Method Summary
Modifier and TypeMethodDescriptionstatic FlowDataset.FlowDatasetBuilder
<?, ?> static FlowDataset
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Deprecated.static FlowDataset
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) static FlowDataset
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.protected boolean
boolean
static FlowDataset
get
(AtlanClient client, String id) Retrieves a FlowDataset by one of its identifiers, complete with all of its relationships.static FlowDataset
get
(AtlanClient client, String id, boolean includeAllRelationships) Retrieves a FlowDataset by one of its identifiers, optionally complete with all of its relationships.static FlowDataset
get
(AtlanClient client, String id, Collection<AtlanField> attributes) Retrieves a FlowDataset by one of its identifiers, with only the requested attributes (and relationships).static FlowDataset
get
(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) Retrieves a FlowDataset by one of its identifiers, with only the requested attributes (and relationships).Reusable unit that details the sub-processing to produce the ephemeral dataset.Optional error message of the flow run.Logic that is applied, injected or otherwise used as part of producing this ephemeral piece of data.Count of the number of individual fields that make up this ephemeral dataset.Fields contained in the ephemeral dataset.Date and time at which this point in the data processing or orchestration finished.Simple name of the folder in which this asset is contained.Unique name of the folder in which this asset is contained.Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.Reusable unit in which the ephemeral dataset is contained.Simple name of the project in which this asset is contained.Unique name of the project in which this asset is contained.Query (e.g.Simple name of the reusable grouping of operations in which this ephemeral data is contained.Unique name of the reusable grouping of operations in which this ephemeral data is contained.Unique ID of the flow run, which could change on subsequent runs of the same flow.Schedule for this point in the data processing or orchestration.Date and time at which this point in the data processing or orchestration started.Overall status of this point in the data processing or orchestration.Type of the ephemeral piece of data.Tasks to which this asset provides input.Processes to which this asset provides input.TBCAttributes implemented by this asset.Entities implemented by this asset.Tasks from which this asset is output.Processes from which this asset is produced as output.TBCFixed typeName for FlowDatasets.int
hashCode()
static FlowDataset
Reference to a FlowDataset by GUID.static FlowDataset
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a FlowDataset by GUID.static FlowDataset
refByQualifiedName
(String qualifiedName) Reference to a FlowDataset by qualifiedName.static FlowDataset
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a FlowDataset by qualifiedName.static FlowDataset
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a FlowDataset.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Deprecated.static FlowDataset
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a FlowDataset.static FlowDataset
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a FlowDataset.static FlowDataset
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a FlowDataset.static FlowDataset
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.static FlowDataset
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a FlowDataset.static FlowDataset
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the FlowDataset.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) FlowDataset to active.static FluentSearch.FluentSearchBuilder
<?, ?> select
(AtlanClient client) Start a fluent search that will return all FlowDataset assets.static FluentSearch.FluentSearchBuilder
<?, ?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all FlowDataset assets.toString()
Builds the minimal object necessary to create a relationship to a FlowDataset, from a potentially more-complete FlowDataset object.Builds the minimal object necessary to apply an update to a FlowDataset, from a potentially more-complete FlowDataset object.static FlowDataset
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a FlowDataset.static FlowDataset
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a FlowDataset.static FlowDataset.FlowDatasetBuilder
<?, ?> Builds the minimal object necessary to update a FlowDataset.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.ICatalog
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.IFlowDataset
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
- See Also:
-
-
Constructor Details
-
FlowDataset
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a FlowDataset, from a potentially more-complete FlowDataset object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the FlowDataset
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a FlowDataset relationship are not found in the initial object
-
select
Start a fluent search that will return all FlowDataset 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) FlowDataset assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all FlowDataset assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all FlowDataset 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 assetsincludeArchived
- when true, archived (soft-deleted) FlowDatasets will be included- Returns:
- a fluent search that includes all FlowDataset assets
-
refByGuid
Reference to a FlowDataset by GUID. Use this to create a relationship to this FlowDataset, where the relationship should be replaced.- Parameters:
guid
- the GUID of the FlowDataset to reference- Returns:
- reference to a FlowDataset that can be used for defining a relationship to a FlowDataset
-
refByGuid
Reference to a FlowDataset by GUID. Use this to create a relationship to this FlowDataset, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the FlowDataset to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a FlowDataset that can be used for defining a relationship to a FlowDataset
-
refByQualifiedName
Reference to a FlowDataset by qualifiedName. Use this to create a relationship to this FlowDataset, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the FlowDataset to reference- Returns:
- reference to a FlowDataset that can be used for defining a relationship to a FlowDataset
-
refByQualifiedName
Reference to a FlowDataset by qualifiedName. Use this to create a relationship to this FlowDataset, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the FlowDataset to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a FlowDataset that can be used for defining a relationship to a FlowDataset
-
get
Retrieves a FlowDataset by one of its identifiers, complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the FlowDataset to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full FlowDataset, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the FlowDataset does not exist or the provided GUID is not a FlowDataset
-
get
public static FlowDataset get(AtlanClient client, String id, boolean includeAllRelationships) throws AtlanException Retrieves a FlowDataset by one of its identifiers, optionally complete with all of its relationships.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the FlowDataset to retrieve, either its GUID or its full qualifiedNameincludeAllRelationships
- if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full FlowDataset, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the FlowDataset does not exist or the provided GUID is not a FlowDataset
-
get
public static FlowDataset get(AtlanClient client, String id, Collection<AtlanField> attributes) throws AtlanException Retrieves a FlowDataset by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the FlowDataset to retrieve, either its GUID or its full qualifiedNameattributes
- to retrieve for the FlowDataset, including any relationships- Returns:
- the requested FlowDataset, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the FlowDataset does not exist or the provided GUID is not a FlowDataset
-
get
public static FlowDataset get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated) throws AtlanException Retrieves a FlowDataset by one of its identifiers, with only the requested attributes (and relationships).- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assetid
- of the FlowDataset to retrieve, either its GUID or its full qualifiedNameattributes
- to retrieve for the FlowDataset, including any relationshipsattributesOnRelated
- to retrieve on each relationship retrieved for the FlowDataset- Returns:
- the requested FlowDataset, with only its minimal information and the requested attributes (and relationships)
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the FlowDataset does not exist or the provided GUID is not a FlowDataset
-
restore
Restore the archived (soft-deleted) FlowDataset to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the FlowDataset- Returns:
- true if the FlowDataset is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
updater
Builds the minimal object necessary to update a FlowDataset.- Parameters:
qualifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the minimal request necessary to update the FlowDataset, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a FlowDataset, from a potentially more-complete FlowDataset object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the FlowDataset, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for FlowDataset are not found in the initial object
-
removeDescription
public static FlowDataset removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the updated FlowDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static FlowDataset removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the updated FlowDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static FlowDataset removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the FlowDataset's ownersqualifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the updated FlowDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static FlowDataset updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to update the FlowDataset's certificatequalifiedName
- of the FlowDatasetcertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated FlowDataset, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static FlowDataset removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the FlowDataset's certificatequalifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the updated FlowDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static FlowDataset updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to update the FlowDataset's announcementqualifiedName
- of the FlowDatasettype
- type of announcement to settitle
- (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 FlowDataset removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a FlowDataset.- Parameters:
client
- connectivity to the Atlan client from which to remove the FlowDataset's announcementqualifiedName
- of the FlowDatasetname
- of the FlowDataset- Returns:
- the updated FlowDataset, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static FlowDataset replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the FlowDataset's assigned termsqualifiedName
- for the FlowDatasetname
- human-readable name of the FlowDatasetterms
- the list of terms to replace on the FlowDataset, or null to remove all terms from the FlowDataset- Returns:
- the FlowDataset that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
@Deprecated public static FlowDataset appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Link additional terms to the FlowDataset, without replacing existing terms linked to the FlowDataset. Note: this operation must make two API calls — one to retrieve the FlowDataset'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 FlowDatasetqualifiedName
- for the FlowDatasetterms
- the list of terms to append to the FlowDataset- Returns:
- the FlowDataset that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
@Deprecated public static FlowDataset removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Remove terms from a FlowDataset, without replacing all existing terms linked to the FlowDataset. Note: this operation must make two API calls — one to retrieve the FlowDataset'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 FlowDatasetqualifiedName
- for the FlowDatasetterms
- the list of terms to remove from the FlowDataset, which must be referenced by GUID- Returns:
- the FlowDataset that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
@Deprecated public static FlowDataset appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Deprecated.Add Atlan tags to a FlowDataset, without replacing existing Atlan tags linked to the FlowDataset. Note: this operation must make two API calls — one to retrieve the FlowDataset'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 FlowDatasetqualifiedName
- of the FlowDatasetatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated FlowDataset
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
@Deprecated public static FlowDataset appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a FlowDataset, without replacing existing Atlan tags linked to the FlowDataset. Note: this operation must make two API calls — one to retrieve the FlowDataset'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 FlowDatasetqualifiedName
- of the FlowDatasetatlanTagNames
- human-readable names of the Atlan tags to addpropagate
- 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 FlowDataset
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
@Deprecated public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Deprecated.Remove an Atlan tag from a FlowDataset.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a FlowDatasetqualifiedName
- of the FlowDatasetatlanTagName
- 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 FlowDataset
-
_internal
-
toBuilder
-
getFlowDetailedBy
Reusable unit that details the sub-processing to produce the ephemeral dataset.- Specified by:
getFlowDetailedBy
in interfaceIFlowDataset
-
getFlowErrorMessage
Optional error message of the flow run.- Specified by:
getFlowErrorMessage
in interfaceIFlow
- Specified by:
getFlowErrorMessage
in interfaceIFlowDataset
-
getFlowExpression
Logic that is applied, injected or otherwise used as part of producing this ephemeral piece of data.- Specified by:
getFlowExpression
in interfaceIFlowDataset
-
getFlowFieldCount
Count of the number of individual fields that make up this ephemeral dataset.- Specified by:
getFlowFieldCount
in interfaceIFlowDataset
-
getFlowFields
Fields contained in the ephemeral dataset.- Specified by:
getFlowFields
in interfaceIFlowDataset
-
getFlowFinishedAt
Date and time at which this point in the data processing or orchestration finished.- Specified by:
getFlowFinishedAt
in interfaceIFlow
- Specified by:
getFlowFinishedAt
in interfaceIFlowDataset
-
getFlowFolderName
Simple name of the folder in which this asset is contained.- Specified by:
getFlowFolderName
in interfaceIFlow
- Specified by:
getFlowFolderName
in interfaceIFlowDataset
-
getFlowFolderQualifiedName
Unique name of the folder in which this asset is contained.- Specified by:
getFlowFolderQualifiedName
in interfaceIFlow
- Specified by:
getFlowFolderQualifiedName
in interfaceIFlowDataset
-
getFlowId
Unique ID for this flow asset, which will remain constant throughout the lifecycle of the asset.- Specified by:
getFlowId
in interfaceIFlow
- Specified by:
getFlowId
in interfaceIFlowDataset
-
getFlowParentUnit
Reusable unit in which the ephemeral dataset is contained.- Specified by:
getFlowParentUnit
in interfaceIFlowDataset
-
getFlowProjectName
Simple name of the project in which this asset is contained.- Specified by:
getFlowProjectName
in interfaceIFlow
- Specified by:
getFlowProjectName
in interfaceIFlowDataset
-
getFlowProjectQualifiedName
Unique name of the project in which this asset is contained.- Specified by:
getFlowProjectQualifiedName
in interfaceIFlow
- Specified by:
getFlowProjectQualifiedName
in interfaceIFlowDataset
-
getFlowQuery
Query (e.g. SQL) that was run to produce this ephemeral piece of data.- Specified by:
getFlowQuery
in interfaceIFlowDataset
-
getFlowReusableUnitName
Simple name of the reusable grouping of operations in which this ephemeral data is contained.- Specified by:
getFlowReusableUnitName
in interfaceIFlow
- Specified by:
getFlowReusableUnitName
in interfaceIFlowDataset
-
getFlowReusableUnitQualifiedName
Unique name of the reusable grouping of operations in which this ephemeral data is contained.- Specified by:
getFlowReusableUnitQualifiedName
in interfaceIFlow
- Specified by:
getFlowReusableUnitQualifiedName
in interfaceIFlowDataset
-
getFlowRunId
Unique ID of the flow run, which could change on subsequent runs of the same flow.- Specified by:
getFlowRunId
in interfaceIFlow
- Specified by:
getFlowRunId
in interfaceIFlowDataset
-
getFlowSchedule
Schedule for this point in the data processing or orchestration.- Specified by:
getFlowSchedule
in interfaceIFlow
- Specified by:
getFlowSchedule
in interfaceIFlowDataset
-
getFlowStartedAt
Date and time at which this point in the data processing or orchestration started.- Specified by:
getFlowStartedAt
in interfaceIFlow
- Specified by:
getFlowStartedAt
in interfaceIFlowDataset
-
getFlowStatus
Overall status of this point in the data processing or orchestration.- Specified by:
getFlowStatus
in interfaceIFlow
- Specified by:
getFlowStatus
in interfaceIFlowDataset
-
getFlowType
Type of the ephemeral piece of data.- Specified by:
getFlowType
in interfaceIFlowDataset
-
getInputToAirflowTasks
Tasks to which this asset provides input.- Specified by:
getInputToAirflowTasks
in interfaceICatalog
- Specified by:
getInputToAirflowTasks
in interfaceIFlowDataset
-
getInputToProcesses
Processes to which this asset provides input.- Specified by:
getInputToProcesses
in interfaceICatalog
- Specified by:
getInputToProcesses
in interfaceIFlowDataset
-
getInputToSparkJobs
TBC- Specified by:
getInputToSparkJobs
in interfaceICatalog
- Specified by:
getInputToSparkJobs
in interfaceIFlowDataset
-
getModelImplementedAttributes
Attributes implemented by this asset.- Specified by:
getModelImplementedAttributes
in interfaceICatalog
- Specified by:
getModelImplementedAttributes
in interfaceIFlowDataset
-
getModelImplementedEntities
Entities implemented by this asset.- Specified by:
getModelImplementedEntities
in interfaceICatalog
- Specified by:
getModelImplementedEntities
in interfaceIFlowDataset
-
getOutputFromAirflowTasks
Tasks from which this asset is output.- Specified by:
getOutputFromAirflowTasks
in interfaceICatalog
- Specified by:
getOutputFromAirflowTasks
in interfaceIFlowDataset
-
getOutputFromProcesses
Processes from which this asset is produced as output.- Specified by:
getOutputFromProcesses
in interfaceICatalog
- Specified by:
getOutputFromProcesses
in interfaceIFlowDataset
-
getOutputFromSparkJobs
TBC- Specified by:
getOutputFromSparkJobs
in interfaceICatalog
- Specified by:
getOutputFromSparkJobs
in interfaceIFlowDataset
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for FlowDatasets.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceICatalog
- Specified by:
getTypeName
in interfaceIFlow
- Specified by:
getTypeName
in interfaceIFlowDataset
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-
Asset.AssetBuilder.appendAtlanTags(List)