Package com.atlan.model.assets

Class AuthPolicy

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.AuthPolicy

All Implemented Interfaces:

IAsset, IAuthPolicy, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2")
public class AuthPolicy
extends Asset
implements IAuthPolicy, IAsset, IReferenceable

Model to store an accesscontrol policy in Atlas

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthPolicy.AuthPolicyBuilder<C extends AuthPolicy,B extends AuthPolicy.AuthPolicyBuilder<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, 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.IAuthPolicy

ACCESS_CONTROL, IS_POLICY_ENABLED, POLICY_ACTIONS, POLICY_CATEGORY, POLICY_CONDITIONS, POLICY_DELEGATE_ADMIN, POLICY_GROUPS, POLICY_MASK_TYPE, POLICY_PRIORITY, POLICY_RESOURCE_CATEGORY, POLICY_RESOURCE_SIGNATURE, POLICY_RESOURCES, POLICY_ROLES, POLICY_SERVICE_NAME, POLICY_SUB_CATEGORY, POLICY_TYPE, POLICY_USERS, POLICY_VALIDITY_SCHEDULE

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	AuthPolicy(AuthPolicy.AuthPolicyBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static AuthPolicy.AuthPolicyBuilder<?,?>	_internal()
static AuthPolicy	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy.
static AuthPolicy	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy.
static AuthPolicy	appendAtlanTags(String qualifiedName, List<String> atlanTagNames)	Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy.
static AuthPolicy	appendAtlanTags(String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy.
protected boolean	canEqual(Object other)
static AuthPolicy.AuthPolicyBuilder<?,?>	creator(String name)	Builds the minimal object necessary to create an AuthPolicy.
boolean	equals(Object o)
static AuthPolicy	get(AtlanClient client, String id)	Retrieves a AuthPolicy by one of its identifiers, complete with all of its relationships.
static AuthPolicy	get(AtlanClient client, String id, boolean includeRelationships)	Retrieves a AuthPolicy by one of its identifiers, optionally complete with all of its relationships.
static AuthPolicy	get(String id)	Retrieves a AuthPolicy by one of its identifiers, complete with all of its relationships.
IAccessControl	getAccessControl()	TBC
Boolean	getIsPolicyEnabled()	TBC
SortedSet<AtlanPolicyAction>	getPolicyActions()	TBC
AuthPolicyCategory	getPolicyCategory()	TBC
List<AuthPolicyCondition>	getPolicyConditions()	TBC
Boolean	getPolicyDelegateAdmin()	TBC
SortedSet<String>	getPolicyGroups()	TBC
DataMaskingType	getPolicyMaskType()	TBC
Integer	getPolicyPriority()	TBC
AuthPolicyResourceCategory	getPolicyResourceCategory()	TBC
SortedSet<String>	getPolicyResources()	TBC
String	getPolicyResourceSignature()	TBC
SortedSet<String>	getPolicyRoles()	TBC
String	getPolicyServiceName()	TBC
String	getPolicySubCategory()	TBC
AuthPolicyType	getPolicyType()	TBC
SortedSet<String>	getPolicyUsers()	TBC
List<AuthPolicyValiditySchedule>	getPolicyValiditySchedule()	TBC
String	getTypeName()	Fixed typeName for AuthPolicys.
int	hashCode()
static AuthPolicy	refByGuid(String guid)	Reference to a AuthPolicy by GUID.
static AuthPolicy	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a AuthPolicy by GUID.
static AuthPolicy	refByQualifiedName(String qualifiedName)	Reference to a AuthPolicy by qualifiedName.
static AuthPolicy	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a AuthPolicy by qualifiedName.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Remove an Atlan tag from a AuthPolicy.
static void	removeAtlanTag(String qualifiedName, String atlanTagName)	Remove an Atlan tag from a AuthPolicy.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) AuthPolicy to active.
static boolean	restore(String qualifiedName)	Restore the archived (soft-deleted) AuthPolicy to active.
static FluentSearch.FluentSearchBuilder<?,?>	select()	Start a fluent search that will return all AuthPolicy assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(boolean includeArchived)	Start a fluent search that will return all AuthPolicy assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all AuthPolicy assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all AuthPolicy assets.
AuthPolicy.AuthPolicyBuilder<?,?>	toBuilder()
String	toString()
AuthPolicy	trimToReference()	Builds the minimal object necessary to create a relationship to a AuthPolicy, from a potentially more-complete AuthPolicy object.
AuthPolicy.AuthPolicyBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to an AuthPolicy, from a potentially more-complete AuthPolicy object.

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

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

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

AuthPolicy

protected AuthPolicy(AuthPolicy.AuthPolicyBuilder<?,?> b)

Method Details

trimToReference

public AuthPolicy trimToReference()
                           throws InvalidRequestException

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

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the AuthPolicy

Throws:

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

select

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

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

Returns:

a fluent search that includes all AuthPolicy assets

select

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

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

Parameters:

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

Returns:

a fluent search that includes all AuthPolicy assets

select

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

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

Returns:

a fluent search that includes all AuthPolicy assets

select

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

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

Returns:

a fluent search that includes all AuthPolicy assets

refByGuid

public static AuthPolicy refByGuid(String guid)

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

Parameters:

guid - the GUID of the AuthPolicy to reference

Returns:

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

refByGuid

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

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

Parameters:

guid - the GUID of the AuthPolicy to reference

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

Returns:

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

refByQualifiedName

public static AuthPolicy refByQualifiedName(String qualifiedName)

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

Parameters:

qualifiedName - the qualifiedName of the AuthPolicy to reference

Returns:

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

refByQualifiedName

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

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

Parameters:

qualifiedName - the qualifiedName of the AuthPolicy to reference

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

Returns:

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

get

public static AuthPolicy get(String id)
                      throws AtlanException

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

Parameters:

id - of the AuthPolicy to retrieve, either its GUID or its full qualifiedName

Returns:

the requested full AuthPolicy, complete with all of its relationships

Throws:

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

get

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

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

Returns:

the requested full AuthPolicy, complete with all of its relationships

Throws:

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

get

public static AuthPolicy get(AtlanClient client,
 String id,
 boolean includeRelationships)
                      throws AtlanException

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

Throws:

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

restore

public static boolean restore(String qualifiedName)
                       throws AtlanException

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

Parameters:

qualifiedName - for the AuthPolicy

Returns:

true if the AuthPolicy is now active, and false otherwise

Throws:

AtlanException - on any API problems

restore

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

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

Parameters:

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

qualifiedName - for the AuthPolicy

Returns:

true if the AuthPolicy is now active, and false otherwise

Throws:

AtlanException - on any API problems

creator

public static AuthPolicy.AuthPolicyBuilder<?,?> creator(String name)

Builds the minimal object necessary to create an AuthPolicy. Note: this method is only for internal use; for creating policies specific to a persona or purpose, use the helper methods from those classes.

Parameters:

name - of the AuthPolicy

Returns:

the minimal request necessary to create the AuthPolicy, as a builder

See Also:

• Persona.createMetadataPolicy(String, String, AuthPolicyType, Collection, String, Collection)
• Persona.createDataPolicy(String, String, AuthPolicyType, String, Collection)
• Persona.createGlossaryPolicy(String, String, AuthPolicyType, Collection, Collection)
• Purpose.createMetadataPolicy(String, String, AuthPolicyType, Collection, Collection, Collection, boolean)
• Purpose.createDataPolicy(String, String, AuthPolicyType, Collection, Collection, boolean)

trimToRequired

public AuthPolicy.AuthPolicyBuilder<?,?> trimToRequired()
                                                 throws InvalidRequestException

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

Overrides:

trimToRequired in class Asset

Returns:

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

Throws:

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

appendAtlanTags

public static AuthPolicy appendAtlanTags(String qualifiedName,
 List<String> atlanTagNames)
                                  throws AtlanException

Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy. Note: this operation must make two API calls — one to retrieve the AuthPolicy's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

qualifiedName - of the AuthPolicy

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

Returns:

the updated AuthPolicy

Throws:

AtlanException - on any API problems

appendAtlanTags

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

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

qualifiedName - of the AuthPolicy

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

Returns:

the updated AuthPolicy

Throws:

AtlanException - on any API problems

appendAtlanTags

public static AuthPolicy appendAtlanTags(String qualifiedName,
 List<String> atlanTagNames,
 boolean propagate,
 boolean removePropagationsOnDelete,
 boolean restrictLineagePropagation)
                                  throws AtlanException

Add Atlan tags to a AuthPolicy, without replacing existing Atlan tags linked to the AuthPolicy. Note: this operation must make two API calls — one to retrieve the AuthPolicy's existing Atlan tags, and a second to append the new Atlan tags.

Parameters:

qualifiedName - of the AuthPolicy

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 AuthPolicy

Throws:

AtlanException - on any API problems

appendAtlanTags

public static AuthPolicy appendAtlanTags(AtlanClient client,
 String qualifiedName,
 List<String> atlanTagNames,
 boolean propagate,
 boolean removePropagationsOnDelete,
 boolean restrictLineagePropagation)
                                  throws AtlanException

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

qualifiedName - of the AuthPolicy

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 AuthPolicy

Throws:

AtlanException - on any API problems

removeAtlanTag

public static void removeAtlanTag(String qualifiedName,
 String atlanTagName)
                           throws AtlanException

Remove an Atlan tag from a AuthPolicy.

Parameters:

qualifiedName - of the AuthPolicy

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 AuthPolicy

removeAtlanTag

public static void removeAtlanTag(AtlanClient client,
 String qualifiedName,
 String atlanTagName)
                           throws AtlanException

Remove an Atlan tag from a AuthPolicy.

Parameters:

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

qualifiedName - of the AuthPolicy

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 AuthPolicy

_internal

public static AuthPolicy.AuthPolicyBuilder<?,?> _internal()

toBuilder

public AuthPolicy.AuthPolicyBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getAccessControl

public IAccessControl getAccessControl()

TBC

Specified by:

getAccessControl in interface IAuthPolicy

getIsPolicyEnabled

public Boolean getIsPolicyEnabled()

TBC

Specified by:

getIsPolicyEnabled in interface IAuthPolicy

getPolicyActions

public SortedSet<AtlanPolicyAction> getPolicyActions()

TBC

Specified by:

getPolicyActions in interface IAuthPolicy

getPolicyCategory

public AuthPolicyCategory getPolicyCategory()

TBC

Specified by:

getPolicyCategory in interface IAuthPolicy

getPolicyConditions

public List<AuthPolicyCondition> getPolicyConditions()

TBC

Specified by:

getPolicyConditions in interface IAuthPolicy

getPolicyDelegateAdmin

public Boolean getPolicyDelegateAdmin()

TBC

Specified by:

getPolicyDelegateAdmin in interface IAuthPolicy

getPolicyGroups

public SortedSet<String> getPolicyGroups()

TBC

Specified by:

getPolicyGroups in interface IAuthPolicy

getPolicyMaskType

public DataMaskingType getPolicyMaskType()

TBC

Specified by:

getPolicyMaskType in interface IAuthPolicy

getPolicyPriority

public Integer getPolicyPriority()

TBC

Specified by:

getPolicyPriority in interface IAuthPolicy

getPolicyResourceCategory

public AuthPolicyResourceCategory getPolicyResourceCategory()

TBC

Specified by:

getPolicyResourceCategory in interface IAuthPolicy

getPolicyResourceSignature

public String getPolicyResourceSignature()

TBC

Specified by:

getPolicyResourceSignature in interface IAuthPolicy

getPolicyResources

public SortedSet<String> getPolicyResources()

TBC

Specified by:

getPolicyResources in interface IAuthPolicy

getPolicyRoles

public SortedSet<String> getPolicyRoles()

TBC

Specified by:

getPolicyRoles in interface IAuthPolicy

getPolicyServiceName

public String getPolicyServiceName()

TBC

Specified by:

getPolicyServiceName in interface IAuthPolicy

getPolicySubCategory

public String getPolicySubCategory()

TBC

Specified by:

getPolicySubCategory in interface IAuthPolicy

getPolicyType

public AuthPolicyType getPolicyType()

TBC

Specified by:

getPolicyType in interface IAuthPolicy

getPolicyUsers

public SortedSet<String> getPolicyUsers()

TBC

Specified by:

getPolicyUsers in interface IAuthPolicy

getPolicyValiditySchedule

public List<AuthPolicyValiditySchedule> getPolicyValiditySchedule()

TBC

Specified by:

getPolicyValiditySchedule in interface IAuthPolicy

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

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface IAuthPolicy

Specified by:

getTypeName in interface IReferenceable

Overrides:

getTypeName in class Reference