Package com.atlan.model.assets
Class BusinessPolicy
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
com.atlan.model.assets.BusinessPolicy
- All Implemented Interfaces:
IAsset
,IBusinessPolicy
,IReferenceable
,AuditDetail
,Serializable
,Comparable<Reference>
@Generated("com.atlan.generators.ModelGeneratorV2")
public class BusinessPolicy
extends Asset
implements IBusinessPolicy, IAsset, IReferenceable
Instance of a business policy template in Atlan.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
BusinessPolicy.BusinessPolicyBuilder<C extends BusinessPolicy,
B extends BusinessPolicy.BusinessPolicyBuilder<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 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, 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_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.IBusinessPolicy
BUSINESS_POLICY_BASE_PARENT_GUID, BUSINESS_POLICY_FILTER_DSL, BUSINESS_POLICY_REVIEW_PERIOD, BUSINESS_POLICY_SELECTED_APPROVAL_WF, BUSINESS_POLICY_TYPE, BUSINESS_POLICY_VALID_FROM, BUSINESS_POLICY_VALID_TILL, BUSINESS_POLICY_VERSION, EXCEPTIONS_FOR_BUSINESS_POLICY, RELATED_BUSINESS_POLICIES
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
ModifierConstructorDescriptionprotected
-
Method Summary
Modifier and TypeMethodDescriptionstatic BusinessPolicy.BusinessPolicyBuilder<?,
?> static BusinessPolicy
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy.static BusinessPolicy
appendAtlanTags
(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy.static BusinessPolicy
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames) Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy.static BusinessPolicy
appendAtlanTags
(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy.static BusinessPolicy
appendTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the BusinessPolicy, without replacing existing terms linked to the BusinessPolicy.static BusinessPolicy
appendTerms
(String qualifiedName, List<IGlossaryTerm> terms) Link additional terms to the BusinessPolicy, without replacing existing terms linked to the BusinessPolicy.protected boolean
boolean
static BusinessPolicy
get
(AtlanClient client, String id) Retrieves a BusinessPolicy by one of its identifiers, complete with all of its relationships.static BusinessPolicy
get
(AtlanClient client, String id, boolean includeRelationships) Retrieves a BusinessPolicy by one of its identifiers, optionally complete with all of its relationships.static BusinessPolicy
Retrieves a BusinessPolicy by one of its identifiers, complete with all of its relationships.Base parent Guid for policy used in versionBusiness Policy Filter ES DSL to denote the associate asset/s involved.Body of the business policy, a long readme like documentDuration for the business policy to complete review.Selected approval workflow id for business policyType of business policyValidity start date of the policyValidity end date of the policyVersion of the policyException assigned to business policesBusinessPolicy that have the same (or relatable) complianceFixed typeName for BusinessPolicys.int
hashCode()
static BusinessPolicy
Reference to a BusinessPolicy by GUID.static BusinessPolicy
refByGuid
(String guid, Reference.SaveSemantic semantic) Reference to a BusinessPolicy by GUID.static BusinessPolicy
refByQualifiedName
(String qualifiedName) Reference to a BusinessPolicy by qualifiedName.static BusinessPolicy
refByQualifiedName
(String qualifiedName, Reference.SaveSemantic semantic) Reference to a BusinessPolicy by qualifiedName.static BusinessPolicy
removeAnnouncement
(AtlanClient client, String qualifiedName, String name) Remove the announcement from a BusinessPolicy.static BusinessPolicy
removeAnnouncement
(String qualifiedName, String name) Remove the announcement from a BusinessPolicy.static void
removeAtlanTag
(AtlanClient client, String qualifiedName, String atlanTagName) Remove an Atlan tag from a BusinessPolicy.static void
removeAtlanTag
(String qualifiedName, String atlanTagName) Remove an Atlan tag from a BusinessPolicy.static BusinessPolicy
removeCertificate
(AtlanClient client, String qualifiedName, String name) Remove the certificate from a BusinessPolicy.static BusinessPolicy
removeCertificate
(String qualifiedName, String name) Remove the certificate from a BusinessPolicy.static BusinessPolicy
removeDescription
(AtlanClient client, String qualifiedName, String name) Remove the system description from a BusinessPolicy.static BusinessPolicy
removeDescription
(String qualifiedName, String name) Remove the system description from a BusinessPolicy.static BusinessPolicy
removeOwners
(AtlanClient client, String qualifiedName, String name) Remove the owners from a BusinessPolicy.static BusinessPolicy
removeOwners
(String qualifiedName, String name) Remove the owners from a BusinessPolicy.static BusinessPolicy
removeTerms
(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a BusinessPolicy, without replacing all existing terms linked to the BusinessPolicy.static BusinessPolicy
removeTerms
(String qualifiedName, List<IGlossaryTerm> terms) Remove terms from a BusinessPolicy, without replacing all existing terms linked to the BusinessPolicy.static BusinessPolicy
removeUserDescription
(AtlanClient client, String qualifiedName, String name) Remove the user's description from a BusinessPolicy.static BusinessPolicy
removeUserDescription
(String qualifiedName, String name) Remove the user's description from a BusinessPolicy.static BusinessPolicy
replaceTerms
(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the BusinessPolicy.static BusinessPolicy
replaceTerms
(String qualifiedName, String name, List<IGlossaryTerm> terms) Replace the terms linked to the BusinessPolicy.static boolean
restore
(AtlanClient client, String qualifiedName) Restore the archived (soft-deleted) BusinessPolicy to active.static boolean
Restore the archived (soft-deleted) BusinessPolicy to active.static FluentSearch.FluentSearchBuilder<?,
?> select()
Start a fluent search that will return all BusinessPolicy assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(boolean includeArchived) Start a fluent search that will return all BusinessPolicy assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client) Start a fluent search that will return all BusinessPolicy assets.static FluentSearch.FluentSearchBuilder<?,
?> select
(AtlanClient client, boolean includeArchived) Start a fluent search that will return all BusinessPolicy assets.toString()
Builds the minimal object necessary to create a relationship to a BusinessPolicy, from a potentially more-complete BusinessPolicy object.Builds the minimal object necessary to apply an update to a BusinessPolicy, from a potentially more-complete BusinessPolicy object.static BusinessPolicy
updateAnnouncement
(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a BusinessPolicy.static BusinessPolicy
updateAnnouncement
(String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on a BusinessPolicy.static BusinessPolicy
updateCertificate
(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a BusinessPolicy.static BusinessPolicy
updateCertificate
(String qualifiedName, CertificateStatus certificate, String message) Update the certificate on a BusinessPolicy.static BusinessPolicy.BusinessPolicyBuilder<?,
?> Builds the minimal object necessary to update a BusinessPolicy.Methods inherited from class com.atlan.model.assets.Asset
addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, 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, lineage, lineage, purge, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceCustomMetadata, replaceTerms, requestLineage, requestLineage, restore, save, save, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, updateCustomMetadataAttributes, 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, 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, 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.IBusinessPolicy
getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, 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, 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
- See Also:
-
-
Constructor Details
-
BusinessPolicy
-
-
Method Details
-
trimToReference
Builds the minimal object necessary to create a relationship to a BusinessPolicy, from a potentially more-complete BusinessPolicy object.- Overrides:
trimToReference
in classAsset
- Returns:
- the minimal object necessary to relate to the BusinessPolicy
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for a BusinessPolicy relationship are not found in the initial object
-
select
Start a fluent search that will return all BusinessPolicy 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) BusinessPolicy assets will be included.- Returns:
- a fluent search that includes all BusinessPolicy assets
-
select
Start a fluent search that will return all BusinessPolicy 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) BusinessPolicy assets will be included.- Parameters:
client
- connectivity to the Atlan tenant from which to retrieve the assets- Returns:
- a fluent search that includes all BusinessPolicy assets
-
select
Start a fluent search that will return all BusinessPolicy 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:
includeArchived
- when true, archived (soft-deleted) BusinessPolicys will be included- Returns:
- a fluent search that includes all BusinessPolicy assets
-
select
public static FluentSearch.FluentSearchBuilder<?,?> select(AtlanClient client, boolean includeArchived) Start a fluent search that will return all BusinessPolicy 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) BusinessPolicys will be included- Returns:
- a fluent search that includes all BusinessPolicy assets
-
refByGuid
Reference to a BusinessPolicy by GUID. Use this to create a relationship to this BusinessPolicy, where the relationship should be replaced.- Parameters:
guid
- the GUID of the BusinessPolicy to reference- Returns:
- reference to a BusinessPolicy that can be used for defining a relationship to a BusinessPolicy
-
refByGuid
Reference to a BusinessPolicy by GUID. Use this to create a relationship to this BusinessPolicy, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
guid
- the GUID of the BusinessPolicy to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a BusinessPolicy that can be used for defining a relationship to a BusinessPolicy
-
refByQualifiedName
Reference to a BusinessPolicy by qualifiedName. Use this to create a relationship to this BusinessPolicy, where the relationship should be replaced.- Parameters:
qualifiedName
- the qualifiedName of the BusinessPolicy to reference- Returns:
- reference to a BusinessPolicy that can be used for defining a relationship to a BusinessPolicy
-
refByQualifiedName
public static BusinessPolicy refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic) Reference to a BusinessPolicy by qualifiedName. Use this to create a relationship to this BusinessPolicy, where you want to further control how that relationship should be updated (i.e. replaced, appended, or removed).- Parameters:
qualifiedName
- the qualifiedName of the BusinessPolicy to referencesemantic
- how to save this relationship (replace all with this, append it, or remove it)- Returns:
- reference to a BusinessPolicy that can be used for defining a relationship to a BusinessPolicy
-
get
Retrieves a BusinessPolicy by one of its identifiers, complete with all of its relationships.- Parameters:
id
- of the BusinessPolicy to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full BusinessPolicy, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the BusinessPolicy does not exist or the provided GUID is not a BusinessPolicy
-
get
Retrieves a BusinessPolicy 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 BusinessPolicy to retrieve, either its GUID or its full qualifiedName- Returns:
- the requested full BusinessPolicy, complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the BusinessPolicy does not exist or the provided GUID is not a BusinessPolicy
-
get
public static BusinessPolicy get(AtlanClient client, String id, boolean includeRelationships) throws AtlanException Retrieves a BusinessPolicy 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 BusinessPolicy to retrieve, either its GUID or its full qualifiedNameincludeRelationships
- if true, all of the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full BusinessPolicy, optionally complete with all of its relationships
- Throws:
AtlanException
- on any error during the API invocation, such as theNotFoundException
if the BusinessPolicy does not exist or the provided GUID is not a BusinessPolicy
-
restore
Restore the archived (soft-deleted) BusinessPolicy to active.- Parameters:
qualifiedName
- for the BusinessPolicy- Returns:
- true if the BusinessPolicy is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
restore
Restore the archived (soft-deleted) BusinessPolicy to active.- Parameters:
client
- connectivity to the Atlan tenant on which to restore the assetqualifiedName
- for the BusinessPolicy- Returns:
- true if the BusinessPolicy is now active, and false otherwise
- Throws:
AtlanException
- on any API problems
-
updater
Builds the minimal object necessary to update a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the minimal request necessary to update the BusinessPolicy, as a builder
-
trimToRequired
Builds the minimal object necessary to apply an update to a BusinessPolicy, from a potentially more-complete BusinessPolicy object.- Overrides:
trimToRequired
in classAsset
- Returns:
- the minimal object necessary to update the BusinessPolicy, as a builder
- Throws:
InvalidRequestException
- if any of the minimal set of required properties for BusinessPolicy are not found in the initial object
-
removeDescription
public static BusinessPolicy removeDescription(String qualifiedName, String name) throws AtlanException Remove the system description from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeDescription
public static BusinessPolicy removeDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the system description from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static BusinessPolicy removeUserDescription(String qualifiedName, String name) throws AtlanException Remove the user's description from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeUserDescription
public static BusinessPolicy removeUserDescription(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the user's description from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant on which to remove the asset's descriptionqualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
Remove the owners from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeOwners
public static BusinessPolicy removeOwners(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the owners from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the BusinessPolicy's ownersqualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static BusinessPolicy updateCertificate(String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicycertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated BusinessPolicy, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
updateCertificate
public static BusinessPolicy updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message) throws AtlanException Update the certificate on a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant on which to update the BusinessPolicy's certificatequalifiedName
- of the BusinessPolicycertificate
- to usemessage
- (optional) message, or null if no message- Returns:
- the updated BusinessPolicy, or null if the update failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static BusinessPolicy removeCertificate(String qualifiedName, String name) throws AtlanException Remove the certificate from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeCertificate
public static BusinessPolicy removeCertificate(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the certificate from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant from which to remove the BusinessPolicy's certificatequalifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
updateAnnouncement
public static BusinessPolicy updateAnnouncement(String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicytype
- 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
-
updateAnnouncement
public static BusinessPolicy updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanException Update the announcement on a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant on which to update the BusinessPolicy's announcementqualifiedName
- of the BusinessPolicytype
- 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 BusinessPolicy removeAnnouncement(String qualifiedName, String name) throws AtlanException Remove the announcement from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
removeAnnouncement
public static BusinessPolicy removeAnnouncement(AtlanClient client, String qualifiedName, String name) throws AtlanException Remove the announcement from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan client from which to remove the BusinessPolicy's announcementqualifiedName
- of the BusinessPolicyname
- of the BusinessPolicy- Returns:
- the updated BusinessPolicy, or null if the removal failed
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static BusinessPolicy replaceTerms(String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the BusinessPolicy.- Parameters:
qualifiedName
- for the BusinessPolicyname
- human-readable name of the BusinessPolicyterms
- the list of terms to replace on the BusinessPolicy, or null to remove all terms from the BusinessPolicy- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
replaceTerms
public static BusinessPolicy replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms) throws AtlanException Replace the terms linked to the BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant on which to replace the BusinessPolicy's assigned termsqualifiedName
- for the BusinessPolicyname
- human-readable name of the BusinessPolicyterms
- the list of terms to replace on the BusinessPolicy, or null to remove all terms from the BusinessPolicy- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static BusinessPolicy appendTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the BusinessPolicy, without replacing existing terms linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy's existing terms, and a second to append the new terms.- Parameters:
qualifiedName
- for the BusinessPolicyterms
- the list of terms to append to the BusinessPolicy- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
appendTerms
public static BusinessPolicy appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Link additional terms to the BusinessPolicy, without replacing existing terms linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy'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 BusinessPolicyqualifiedName
- for the BusinessPolicyterms
- the list of terms to append to the BusinessPolicy- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static BusinessPolicy removeTerms(String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a BusinessPolicy, without replacing all existing terms linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy's existing terms, and a second to remove the provided terms.- Parameters:
qualifiedName
- for the BusinessPolicyterms
- the list of terms to remove from the BusinessPolicy, which must be referenced by GUID- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
removeTerms
public static BusinessPolicy removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Remove terms from a BusinessPolicy, without replacing all existing terms linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy'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 BusinessPolicyqualifiedName
- for the BusinessPolicyterms
- the list of terms to remove from the BusinessPolicy, which must be referenced by GUID- Returns:
- the BusinessPolicy that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static BusinessPolicy appendAtlanTags(String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the BusinessPolicyatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated BusinessPolicy
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static BusinessPolicy appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames) throws AtlanException Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy'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 BusinessPolicyqualifiedName
- of the BusinessPolicyatlanTagNames
- human-readable names of the Atlan tags to add- Returns:
- the updated BusinessPolicy
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static BusinessPolicy appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
qualifiedName
- of the BusinessPolicyatlanTagNames
- 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 BusinessPolicy
- Throws:
AtlanException
- on any API problems
-
appendAtlanTags
public static BusinessPolicy appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to a BusinessPolicy, without replacing existing Atlan tags linked to the BusinessPolicy. Note: this operation must make two API calls — one to retrieve the BusinessPolicy'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 BusinessPolicyqualifiedName
- of the BusinessPolicyatlanTagNames
- 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 BusinessPolicy
- Throws:
AtlanException
- on any API problems
-
removeAtlanTag
Remove an Atlan tag from a BusinessPolicy.- Parameters:
qualifiedName
- of the BusinessPolicyatlanTagName
- 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 BusinessPolicy
-
removeAtlanTag
public static void removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName) throws AtlanException Remove an Atlan tag from a BusinessPolicy.- Parameters:
client
- connectivity to the Atlan tenant from which to remove an Atlan tag from a BusinessPolicyqualifiedName
- of the BusinessPolicyatlanTagName
- 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 BusinessPolicy
-
_internal
-
toBuilder
-
getBusinessPolicyBaseParentGuid
Base parent Guid for policy used in version- Specified by:
getBusinessPolicyBaseParentGuid
in interfaceIBusinessPolicy
-
getBusinessPolicyFilterDSL
Business Policy Filter ES DSL to denote the associate asset/s involved.- Specified by:
getBusinessPolicyFilterDSL
in interfaceIBusinessPolicy
-
getBusinessPolicyLongDescription
Body of the business policy, a long readme like document- Specified by:
getBusinessPolicyLongDescription
in interfaceIBusinessPolicy
-
getBusinessPolicyReviewPeriod
Duration for the business policy to complete review.- Specified by:
getBusinessPolicyReviewPeriod
in interfaceIBusinessPolicy
-
getBusinessPolicySelectedApprovalWF
Selected approval workflow id for business policy- Specified by:
getBusinessPolicySelectedApprovalWF
in interfaceIBusinessPolicy
-
getBusinessPolicyType
Type of business policy- Specified by:
getBusinessPolicyType
in interfaceIBusinessPolicy
-
getBusinessPolicyValidFrom
Validity start date of the policy- Specified by:
getBusinessPolicyValidFrom
in interfaceIBusinessPolicy
-
getBusinessPolicyValidTill
Validity end date of the policy- Specified by:
getBusinessPolicyValidTill
in interfaceIBusinessPolicy
-
getBusinessPolicyVersion
Version of the policy- Specified by:
getBusinessPolicyVersion
in interfaceIBusinessPolicy
-
getExceptionsForBusinessPolicy
Exception assigned to business polices- Specified by:
getExceptionsForBusinessPolicy
in interfaceIBusinessPolicy
-
getRelatedBusinessPolicies
BusinessPolicy that have the same (or relatable) compliance- Specified by:
getRelatedBusinessPolicies
in interfaceIBusinessPolicy
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
getTypeName
Fixed typeName for BusinessPolicys.- Specified by:
getTypeName
in interfaceAuditDetail
- Specified by:
getTypeName
in interfaceIAsset
- Specified by:
getTypeName
in interfaceIBusinessPolicy
- Specified by:
getTypeName
in interfaceIReferenceable
- Overrides:
getTypeName
in classReference
-