com.atlan.model.assets.BusinessProcessModelEntity

All Implemented Interfaces:: IAsset, IBusinessProcessModel, IBusinessProcessModelEntity, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2") public class BusinessProcessModelEntity extends Asset implements IBusinessProcessModelEntity, IBusinessProcessModel, ICatalog, IAsset, IReferenceable

Instances of BusinessProcessModelEntity in Atlan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<C extends BusinessProcessModelEntity,B extends BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<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_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_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, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, 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, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, 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.IBusinessProcessModel
BUSINESS_PROCESS_MODEL_TYPE

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

BusinessProcessModelEntity(BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> b)
Method Summary

Modifier and Type

Method

Description

static BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?>

_internal()

static BusinessProcessModelEntity

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

Add Atlan tags to a BusinessProcessModelEntity, without replacing existing Atlan tags linked to the BusinessProcessModelEntity.

static BusinessProcessModelEntity

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

Add Atlan tags to a BusinessProcessModelEntity, without replacing existing Atlan tags linked to the BusinessProcessModelEntity.

static BusinessProcessModelEntity

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

Link additional terms to the BusinessProcessModelEntity, without replacing existing terms linked to the BusinessProcessModelEntity.

protected boolean

canEqual(Object other)

boolean

equals(Object o)

static BusinessProcessModelEntity

get(AtlanClient client, String id)

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

static BusinessProcessModelEntity

get(AtlanClient client, String id, boolean includeRelationships)

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

String

getBusinessProcessModelType()

Type attribute for the BusinessProcessModel asset to help distinguish the entity type.

SortedSet<IAirflowTask>

getInputToAirflowTasks()

Tasks to which this asset provides input.

SortedSet<ILineageProcess>

getInputToProcesses()

Processes to which this asset provides input.

SortedSet<ISparkJob>

getInputToSparkJobs()

TBC

SortedSet<IModelAttribute>

getModelImplementedAttributes()

Attributes implemented by this asset.

SortedSet<IModelEntity>

getModelImplementedEntities()

Entities implemented by this asset.

SortedSet<IAirflowTask>

getOutputFromAirflowTasks()

Tasks from which this asset is output.

SortedSet<ILineageProcess>

getOutputFromProcesses()

Processes from which this asset is produced as output.

SortedSet<ISparkJob>

getOutputFromSparkJobs()

TBC

String

getTypeName()

Fixed typeName for BusinessProcessModelEntitys.

int

hashCode()

static BusinessProcessModelEntity

refByGuid(String guid)

Reference to a BusinessProcessModelEntity by GUID.

static BusinessProcessModelEntity

refByGuid(String guid, Reference.SaveSemantic semantic)

Reference to a BusinessProcessModelEntity by GUID.

static BusinessProcessModelEntity

refByQualifiedName(String qualifiedName)

Reference to a BusinessProcessModelEntity by qualifiedName.

static BusinessProcessModelEntity

refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)

Reference to a BusinessProcessModelEntity by qualifiedName.

static BusinessProcessModelEntity

removeAnnouncement(AtlanClient client, String qualifiedName, String name)

Remove the announcement from a BusinessProcessModelEntity.

static void

removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)

Remove an Atlan tag from a BusinessProcessModelEntity.

static BusinessProcessModelEntity

removeCertificate(AtlanClient client, String qualifiedName, String name)

Remove the certificate from a BusinessProcessModelEntity.

static BusinessProcessModelEntity

removeDescription(AtlanClient client, String qualifiedName, String name)

Remove the system description from a BusinessProcessModelEntity.

static BusinessProcessModelEntity

removeOwners(AtlanClient client, String qualifiedName, String name)

Remove the owners from a BusinessProcessModelEntity.

static BusinessProcessModelEntity

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

Remove terms from a BusinessProcessModelEntity, without replacing all existing terms linked to the BusinessProcessModelEntity.

static BusinessProcessModelEntity

removeUserDescription(AtlanClient client, String qualifiedName, String name)

Remove the user's description from a BusinessProcessModelEntity.

static BusinessProcessModelEntity

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

Replace the terms linked to the BusinessProcessModelEntity.

static boolean

restore(AtlanClient client, String qualifiedName)

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

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client)

Start a fluent search that will return all BusinessProcessModelEntity assets.

static FluentSearch.FluentSearchBuilder<?,?>

select(AtlanClient client, boolean includeArchived)

Start a fluent search that will return all BusinessProcessModelEntity assets.

BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?>

toBuilder()

String

toString()

BusinessProcessModelEntity

trimToReference()

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

BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?>

trimToRequired()

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

static BusinessProcessModelEntity

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

Update the announcement on a BusinessProcessModelEntity.

static BusinessProcessModelEntity

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

Update the certificate on a BusinessProcessModelEntity.

static BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?>

updater(String qualifiedName, String name)

Builds the minimal object necessary to update a BusinessProcessModelEntity.

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, 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, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getCreatedBy, getCreateTime, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getFiles, getHasContract, getHasLineage, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, 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, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, updateMergingCM, 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, 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, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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.IBusinessProcessModel
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, 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, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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.IBusinessProcessModelEntity
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, 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, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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, 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, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetTags, getAssetThemeHex, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOwnerGroups, getOwnerUsers, getPopularityScore, 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
- BusinessProcessModelEntity
  
  protected BusinessProcessModelEntity(BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> b)
Method Details
- trimToReference
  
  public BusinessProcessModelEntity trimToReference() throws InvalidRequestException
  
  Builds the minimal object necessary to create a relationship to a BusinessProcessModelEntity, from a potentially more-complete BusinessProcessModelEntity object.
  
  Overrides:
  
  trimToReference in class Asset
  
  Returns:
  
  the minimal object necessary to relate to the BusinessProcessModelEntity
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for a BusinessProcessModelEntity relationship are not found in the initial object
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client)
  
  Start a fluent search that will return all BusinessProcessModelEntity 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) BusinessProcessModelEntity assets will be included.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to retrieve the assets
  
  Returns:
  
  a fluent search that includes all BusinessProcessModelEntity assets
- select
  
  public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived)
  
  Start a fluent search that will return all BusinessProcessModelEntity 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) BusinessProcessModelEntitys will be included
  
  Returns:
  
  a fluent search that includes all BusinessProcessModelEntity assets
- refByGuid
  
  public static BusinessProcessModelEntity refByGuid(String guid)
  
  Reference to a BusinessProcessModelEntity by GUID. Use this to create a relationship to this BusinessProcessModelEntity, where the relationship should be replaced.
  
  Parameters:
  
  guid - the GUID of the BusinessProcessModelEntity to reference
  
  Returns:
  
  reference to a BusinessProcessModelEntity that can be used for defining a relationship to a BusinessProcessModelEntity
- refByGuid
  
  public static BusinessProcessModelEntity refByGuid(String guid, Reference.SaveSemantic semantic)
  
  Reference to a BusinessProcessModelEntity by GUID. Use this to create a relationship to this BusinessProcessModelEntity, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  guid - the GUID of the BusinessProcessModelEntity to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a BusinessProcessModelEntity that can be used for defining a relationship to a BusinessProcessModelEntity
- refByQualifiedName
  
  public static BusinessProcessModelEntity refByQualifiedName(String qualifiedName)
  
  Reference to a BusinessProcessModelEntity by qualifiedName. Use this to create a relationship to this BusinessProcessModelEntity, where the relationship should be replaced.
  
  Parameters:
  
  qualifiedName - the qualifiedName of the BusinessProcessModelEntity to reference
  
  Returns:
  
  reference to a BusinessProcessModelEntity that can be used for defining a relationship to a BusinessProcessModelEntity
- refByQualifiedName
  
  public static BusinessProcessModelEntity refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)
  
  Reference to a BusinessProcessModelEntity by qualifiedName. Use this to create a relationship to this BusinessProcessModelEntity, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).
  
  Parameters:
  
  qualifiedName - the qualifiedName of the BusinessProcessModelEntity to reference
  
  semantic - how to save this relationship (replace all with this, append it, or remove it)
  
  Returns:
  
  reference to a BusinessProcessModelEntity that can be used for defining a relationship to a BusinessProcessModelEntity
- get
  
  public static BusinessProcessModelEntity get(AtlanClient client, String id) throws AtlanException
  
  Retrieves a BusinessProcessModelEntity 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 BusinessProcessModelEntity to retrieve, either its GUID or its full qualifiedName
  
  Returns:
  
  the requested full BusinessProcessModelEntity, complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the BusinessProcessModelEntity does not exist or the provided GUID is not a BusinessProcessModelEntity
- get
  
  public static BusinessProcessModelEntity get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException
  
  Retrieves a BusinessProcessModelEntity 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 BusinessProcessModelEntity to retrieve, either its GUID or its full qualifiedName
  
  includeRelationships - if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved
  
  Returns:
  
  the requested full BusinessProcessModelEntity, optionally complete with all of its relationships
  
  Throws:
  
  AtlanException - on any error during the API invocation, such as the NotFoundException if the BusinessProcessModelEntity does not exist or the provided GUID is not a BusinessProcessModelEntity
- restore
  
  public static boolean restore(AtlanClient client, String qualifiedName) throws AtlanException
  
  Restore the archived (soft-deleted) BusinessProcessModelEntity to active.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to restore the asset
  
  qualifiedName - for the BusinessProcessModelEntity
  
  Returns:
  
  true if the BusinessProcessModelEntity is now active, and false otherwise
  
  Throws:
  
  AtlanException - on any API problems
- updater
  
  public static BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> updater(String qualifiedName, String name)
  
  Builds the minimal object necessary to update a BusinessProcessModelEntity.
  
  Parameters:
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the minimal request necessary to update the BusinessProcessModelEntity, as a builder
- trimToRequired
  
  public BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> trimToRequired() throws InvalidRequestException
  
  Builds the minimal object necessary to apply an update to a BusinessProcessModelEntity, from a potentially more-complete BusinessProcessModelEntity object.
  
  Overrides:
  
  trimToRequired in class Asset
  
  Returns:
  
  the minimal object necessary to update the BusinessProcessModelEntity, as a builder
  
  Throws:
  
  InvalidRequestException - if any of the minimal set of required properties for BusinessProcessModelEntity are not found in the initial object
- removeDescription
  
  public static BusinessProcessModelEntity removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the system description from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeUserDescription
  
  public static BusinessProcessModelEntity removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the user's description from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to remove the asset's description
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- removeOwners
  
  public static BusinessProcessModelEntity removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the owners from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the BusinessProcessModelEntity's owners
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateCertificate
  
  public static BusinessProcessModelEntity updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException
  
  Update the certificate on a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the BusinessProcessModelEntity's certificate
  
  qualifiedName - of the BusinessProcessModelEntity
  
  certificate - to use
  
  message - (optional) message, or null if no message
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the update failed
  
  Throws:
  
  AtlanException - on any API problems
- removeCertificate
  
  public static BusinessProcessModelEntity removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the certificate from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove the BusinessProcessModelEntity's certificate
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- updateAnnouncement
  
  public static BusinessProcessModelEntity updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException
  
  Update the announcement on a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to update the BusinessProcessModelEntity's announcement
  
  qualifiedName - of the BusinessProcessModelEntity
  
  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 BusinessProcessModelEntity removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException
  
  Remove the announcement from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan client from which to remove the BusinessProcessModelEntity's announcement
  
  qualifiedName - of the BusinessProcessModelEntity
  
  name - of the BusinessProcessModelEntity
  
  Returns:
  
  the updated BusinessProcessModelEntity, or null if the removal failed
  
  Throws:
  
  AtlanException - on any API problems
- replaceTerms
  
  public static BusinessProcessModelEntity replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException
  
  Replace the terms linked to the BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant on which to replace the BusinessProcessModelEntity's assigned terms
  
  qualifiedName - for the BusinessProcessModelEntity
  
  name - human-readable name of the BusinessProcessModelEntity
  
  terms - the list of terms to replace on the BusinessProcessModelEntity, or null to remove all terms from the BusinessProcessModelEntity
  
  Returns:
  
  the BusinessProcessModelEntity that was updated (note that it will NOT contain details of the replaced terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendTerms
  
  public static BusinessProcessModelEntity appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Link additional terms to the BusinessProcessModelEntity, without replacing existing terms linked to the BusinessProcessModelEntity. Note: this operation must make two API calls — one to retrieve the BusinessProcessModelEntity'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 BusinessProcessModelEntity
  
  qualifiedName - for the BusinessProcessModelEntity
  
  terms - the list of terms to append to the BusinessProcessModelEntity
  
  Returns:
  
  the BusinessProcessModelEntity that was updated (note that it will NOT contain details of the appended terms)
  
  Throws:
  
  AtlanException - on any API problems
- removeTerms
  
  public static BusinessProcessModelEntity removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
  
  Remove terms from a BusinessProcessModelEntity, without replacing all existing terms linked to the BusinessProcessModelEntity. Note: this operation must make two API calls — one to retrieve the BusinessProcessModelEntity'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 BusinessProcessModelEntity
  
  qualifiedName - for the BusinessProcessModelEntity
  
  terms - the list of terms to remove from the BusinessProcessModelEntity, which must be referenced by GUID
  
  Returns:
  
  the BusinessProcessModelEntity that was updated (note that it will NOT contain details of the resulting terms)
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  public static BusinessProcessModelEntity appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException
  
  Add Atlan tags to a BusinessProcessModelEntity, without replacing existing Atlan tags linked to the BusinessProcessModelEntity. Note: this operation must make two API calls — one to retrieve the BusinessProcessModelEntity'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 BusinessProcessModelEntity
  
  qualifiedName - of the BusinessProcessModelEntity
  
  atlanTagNames - human-readable names of the Atlan tags to add
  
  Returns:
  
  the updated BusinessProcessModelEntity
  
  Throws:
  
  AtlanException - on any API problems
- appendAtlanTags
  
  public static BusinessProcessModelEntity appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
  
  Add Atlan tags to a BusinessProcessModelEntity, without replacing existing Atlan tags linked to the BusinessProcessModelEntity. Note: this operation must make two API calls — one to retrieve the BusinessProcessModelEntity'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 BusinessProcessModelEntity
  
  qualifiedName - of the BusinessProcessModelEntity
  
  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 BusinessProcessModelEntity
  
  Throws:
  
  AtlanException - on any API problems
- removeAtlanTag
  
  public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException
  
  Remove an Atlan tag from a BusinessProcessModelEntity.
  
  Parameters:
  
  client - connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessProcessModelEntity
  
  qualifiedName - of the BusinessProcessModelEntity
  
  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 BusinessProcessModelEntity
- _internal
  
  public static BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> _internal()
- toBuilder
  
  public BusinessProcessModelEntity.BusinessProcessModelEntityBuilder<?,?> toBuilder()
  
  Overrides:
  
  toBuilder in class Reference
- getBusinessProcessModelType
  
  public String getBusinessProcessModelType()
  
  Type attribute for the BusinessProcessModel asset to help distinguish the entity type.
  
  Specified by:
  
  getBusinessProcessModelType in interface IBusinessProcessModel
  
  Specified by:
  
  getBusinessProcessModelType in interface IBusinessProcessModelEntity
- getInputToAirflowTasks
  
  public SortedSet<IAirflowTask> getInputToAirflowTasks()
  
  Tasks to which this asset provides input.
  
  Specified by:
  
  getInputToAirflowTasks in interface IBusinessProcessModel
  
  Specified by:
  
  getInputToAirflowTasks in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getInputToAirflowTasks in interface ICatalog
- getInputToProcesses
  
  public SortedSet<ILineageProcess> getInputToProcesses()
  
  Processes to which this asset provides input.
  
  Specified by:
  
  getInputToProcesses in interface IBusinessProcessModel
  
  Specified by:
  
  getInputToProcesses in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getInputToProcesses in interface ICatalog
- getInputToSparkJobs
  
  public SortedSet<ISparkJob> getInputToSparkJobs()
  
  TBC
  
  Specified by:
  
  getInputToSparkJobs in interface IBusinessProcessModel
  
  Specified by:
  
  getInputToSparkJobs in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getInputToSparkJobs in interface ICatalog
- getModelImplementedAttributes
  
  public SortedSet<IModelAttribute> getModelImplementedAttributes()
  
  Attributes implemented by this asset.
  
  Specified by:
  
  getModelImplementedAttributes in interface IBusinessProcessModel
  
  Specified by:
  
  getModelImplementedAttributes in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getModelImplementedAttributes in interface ICatalog
- getModelImplementedEntities
  
  public SortedSet<IModelEntity> getModelImplementedEntities()
  
  Entities implemented by this asset.
  
  Specified by:
  
  getModelImplementedEntities in interface IBusinessProcessModel
  
  Specified by:
  
  getModelImplementedEntities in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getModelImplementedEntities in interface ICatalog
- getOutputFromAirflowTasks
  
  public SortedSet<IAirflowTask> getOutputFromAirflowTasks()
  
  Tasks from which this asset is output.
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IBusinessProcessModel
  
  Specified by:
  
  getOutputFromAirflowTasks in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getOutputFromAirflowTasks in interface ICatalog
- getOutputFromProcesses
  
  public SortedSet<ILineageProcess> getOutputFromProcesses()
  
  Processes from which this asset is produced as output.
  
  Specified by:
  
  getOutputFromProcesses in interface IBusinessProcessModel
  
  Specified by:
  
  getOutputFromProcesses in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getOutputFromProcesses in interface ICatalog
- getOutputFromSparkJobs
  
  public SortedSet<ISparkJob> getOutputFromSparkJobs()
  
  TBC
  
  Specified by:
  
  getOutputFromSparkJobs in interface IBusinessProcessModel
  
  Specified by:
  
  getOutputFromSparkJobs in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getOutputFromSparkJobs in interface ICatalog
- 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 BusinessProcessModelEntitys.
  
  Specified by:
  
  getTypeName in interface AuditDetail
  
  Specified by:
  
  getTypeName in interface IAsset
  
  Specified by:
  
  getTypeName in interface IBusinessProcessModel
  
  Specified by:
  
  getTypeName in interface IBusinessProcessModelEntity
  
  Specified by:
  
  getTypeName in interface ICatalog
  
  Specified by:
  
  getTypeName in interface IReferenceable
  
  Overrides:
  
  getTypeName in class Reference

Class BusinessProcessModelEntity

Nested Class Summary

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

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

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

Field Summary

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

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

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

Field Details

TYPE_NAME

Constructor Details

BusinessProcessModelEntity

Method Details

trimToReference

select

select

refByGuid

refByGuid

refByQualifiedName

refByQualifiedName

get

get

restore

updater

trimToRequired

removeDescription

removeUserDescription

removeOwners

updateCertificate

removeCertificate

updateAnnouncement

removeAnnouncement

replaceTerms

appendTerms

removeTerms

appendAtlanTags

appendAtlanTags

removeAtlanTag

_internal

toBuilder

getBusinessProcessModelType

getInputToAirflowTasks

getInputToProcesses

getInputToSparkJobs

getModelImplementedAttributes

getModelImplementedEntities

getOutputFromAirflowTasks

getOutputFromProcesses

getOutputFromSparkJobs

equals

canEqual

hashCode

toString

getTypeName