Package com.atlan.model.assets

Class Purpose.PurposeBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>

java.lang.Object

com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>

com.atlan.model.relations.Reference.ReferenceBuilder<C,B>

com.atlan.model.assets.Asset.AssetBuilder<C,B>

com.atlan.model.assets.Purpose.PurposeBuilder<C,B>

Enclosing class:

Purpose

public abstract static class Purpose.PurposeBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>
extends Asset.AssetBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
PurposeBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
abstract C	build()
B	channelLink(String channelLink)	TBC
B	clearDenyAssetFilters()
B	clearDenyAssetMetadataTypes()
B	clearDenyAssetTabs()
B	clearDenyAssetTypes()
B	clearDenyCustomMetadataGuids()
B	clearDenyNavigationPages()
B	clearDenySidebarTabs()
B	clearDisplayPreferences()
B	clearPolicies()
B	clearPurposeAtlanTags()
B	defaultNavigation(String defaultNavigation)	TBC
B	denyAssetFilter(AssetFilterGroup denyAssetFilter)
B	denyAssetFilters(Collection<? extends AssetFilterGroup> denyAssetFilters)
B	denyAssetMetadataType(String denyAssetMetadataType)
B	denyAssetMetadataTypes(Collection<? extends String> denyAssetMetadataTypes)
B	denyAssetTab(AssetSidebarTab denyAssetTab)
B	denyAssetTabs(Collection<? extends AssetSidebarTab> denyAssetTabs)
B	denyAssetType(String denyAssetType)
B	denyAssetTypes(Collection<? extends String> denyAssetTypes)
B	denyCustomMetadataGuid(String denyCustomMetadataGuid)
B	denyCustomMetadataGuids(Collection<? extends String> denyCustomMetadataGuids)
B	denyNavigationPage(String denyNavigationPage)
B	denyNavigationPages(Collection<? extends String> denyNavigationPages)
B	denySidebarTab(String denySidebarTab)
B	denySidebarTabs(Collection<? extends String> denySidebarTabs)
B	displayPreference(String displayPreference)
B	displayPreferences(Collection<? extends String> displayPreferences)
B	isAccessControlEnabled(Boolean isAccessControlEnabled)	TBC
B	policies(Collection<? extends IAuthPolicy> policies)
B	policy(IAuthPolicy policy)
B	purposeAtlanTag(String purposeAtlanTag)
B	purposeAtlanTags(Collection<? extends String> purposeAtlanTags)
protected abstract B	self()
String	toString()
B	typeName(String typeName)	Fixed typeName for Purposes.

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

addStarredBy, adminGroup, adminGroups, adminRole, adminRoles, adminUser, adminUsers, announcementMessage, announcementTitle, announcementType, announcementUpdatedAt, announcementUpdatedBy, anomaloCheck, anomaloChecks, appendAssignedTerm, appendAtlanTag, appendAtlanTag, appendAtlanTags, appendAtlanTags, application, applicationField, applicationFieldQualifiedName, applicationQualifiedName, assetAnomaloAppliedCheckType, assetAnomaloAppliedCheckTypes, assetAnomaloCheckCount, assetAnomaloCheckStatuses, assetAnomaloDQStatus, assetAnomaloFailedCheckCount, assetAnomaloFailedCheckType, assetAnomaloFailedCheckTypes, assetAnomaloLastCheckRunAt, assetAnomaloSourceUrl, assetCoverImage, assetDbtAccountName, assetDbtAlias, assetDbtEnvironmentDbtVersion, assetDbtEnvironmentName, assetDbtJobLastRun, assetDbtJobLastRunArtifactS3Path, assetDbtJobLastRunArtifactsSaved, assetDbtJobLastRunCreatedAt, assetDbtJobLastRunDequedAt, assetDbtJobLastRunExecutedByThreadId, assetDbtJobLastRunGitBranch, assetDbtJobLastRunGitSha, assetDbtJobLastRunHasDocsGenerated, assetDbtJobLastRunHasSourcesGenerated, assetDbtJobLastRunNotificationsSent, assetDbtJobLastRunOwnerThreadId, assetDbtJobLastRunQueuedDuration, assetDbtJobLastRunQueuedDurationHumanized, assetDbtJobLastRunRunDuration, assetDbtJobLastRunRunDurationHumanized, assetDbtJobLastRunStartedAt, assetDbtJobLastRunStatusMessage, assetDbtJobLastRunTotalDuration, assetDbtJobLastRunTotalDurationHumanized, assetDbtJobLastRunUpdatedAt, assetDbtJobLastRunUrl, assetDbtJobName, assetDbtJobNextRun, assetDbtJobNextRunHumanized, assetDbtJobSchedule, assetDbtJobScheduleCronHumanized, assetDbtJobStatus, assetDbtMeta, assetDbtPackageName, assetDbtProjectName, assetDbtSemanticLayerProxyUrl, assetDbtSourceFreshnessCriteria, assetDbtTag, assetDbtTags, assetDbtTestStatus, assetDbtUniqueId, assetDbtWorkflowLastUpdated, assetDQFreshnessExpectation, assetDQFreshnessValue, assetDQResult, assetDQRowScopeFilterColumnQualifiedName, assetDQRuleAttachedDimension, assetDQRuleAttachedDimensions, assetDQRuleAttachedRuleType, assetDQRuleAttachedRuleTypes, assetDQRuleFailedCount, assetDQRuleFailedDimension, assetDQRuleFailedDimensions, assetDQRuleFailedRuleType, assetDQRuleFailedRuleTypes, assetDQRuleLastRunAt, assetDQRulePassedCount, assetDQRulePassedDimension, assetDQRulePassedDimensions, assetDQRulePassedRuleType, assetDQRulePassedRuleTypes, assetDQRuleResultTag, assetDQRuleResultTags, assetDQRuleTotalCount, assetDQScheduleCrontab, assetDQScheduleSourceSyncedAt, assetDQScheduleSourceSyncErrorCode, assetDQScheduleSourceSyncErrorMessage, assetDQScheduleSourceSyncRawError, assetDQScheduleSourceSyncStatus, assetDQScheduleTimeZone, assetDQScheduleType, assetExternalDQMetadataDetail, assetExternalDQMetadataDetails, assetIcon, assetInternalPopularityScore, assetMcAlertQualifiedName, assetMcAlertQualifiedNames, assetMcIncidentName, assetMcIncidentNames, assetMcIncidentPriorities, assetMcIncidentPriority, assetMcIncidentQualifiedName, assetMcIncidentQualifiedNames, assetMcIncidentSeverities, assetMcIncidentSeverity, assetMcIncidentState, assetMcIncidentStates, assetMcIncidentSubType, assetMcIncidentSubTypes, assetMcIncidentType, assetMcIncidentTypes, assetMcIsMonitored, assetMcLastSyncRunAt, assetMcMonitorName, assetMcMonitorNames, assetMcMonitorQualifiedName, assetMcMonitorQualifiedNames, assetMcMonitorScheduleType, assetMcMonitorScheduleTypes, assetMcMonitorStatus, assetMcMonitorStatuses, assetMcMonitorType, assetMcMonitorTypes, assetPoliciesCount, assetPolicyGUID, assetPolicyGUIDs, assetRedirectGUID, assetRedirectGUIDs, assetSodaCheckCount, assetSodaCheckStatuses, assetSodaDQStatus, assetSodaLastScanAt, assetSodaLastSyncRunAt, assetSodaSourceURL, assetSourceReadme, assetSpaceName, assetSpaceQualifiedName, assetTag, assetTags, assetThemeHex, assetUserDefinedType, assignedTerm, assignedTerms, atlanTag, atlanTagName, atlanTagNames, atlanTags, certificateStatus, certificateStatusMessage, certificateUpdatedAt, certificateUpdatedBy, clearAdminGroups, clearAdminRoles, clearAdminUsers, clearAnomaloChecks, clearAssetAnomaloAppliedCheckTypes, clearAssetAnomaloFailedCheckTypes, clearAssetDbtTags, clearAssetDQRuleAttachedDimensions, clearAssetDQRuleAttachedRuleTypes, clearAssetDQRuleFailedDimensions, clearAssetDQRuleFailedRuleTypes, clearAssetDQRulePassedDimensions, clearAssetDQRulePassedRuleTypes, clearAssetDQRuleResultTags, clearAssetExternalDQMetadataDetails, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetRedirectGUIDs, clearAssetTags, clearAssignedTerms, clearAtlanTagNames, clearAtlanTags, clearCustomMetadataSets, clearDomainGUIDs, clearDqBaseDatasetRules, clearDqReferenceDatasetRules, clearFiles, clearInputPortDataProducts, clearLinks, clearMcIncidents, clearMcMonitors, clearMeaningNames, clearMeanings, clearMetrics, clearNonCompliantAssetPolicyGUIDs, clearNullFields, clearOutputPortDataProducts, clearOutputProductGUIDs, clearOwnerGroups, clearOwnerUsers, clearPendingTasks, clearProductGUIDs, clearSchemaRegistrySubjects, clearSodaChecks, clearSourceQueryComputeCostRecords, clearSourceQueryComputeCosts, clearSourceReadExpensiveQueryRecords, clearSourceReadPopularQueryRecords, clearSourceReadRecentUserRecords, clearSourceReadRecentUsers, clearSourceReadSlowQueryRecords, clearSourceReadTopUserRecords, clearSourceReadTopUsers, clearStarredBy, clearStarredDetails, clearUserDefRelationshipFroms, clearUserDefRelationshipTos, clearViewerGroups, clearViewerUsers, connectionName, connectionQualifiedName, connectorName, connectorType, createdBy, createTime, customConnectorType, customMetadata, customMetadataSets, dataContractLatest, dataContractLatestCertified, dbtQualifiedName, deleteHandler, depth, description, displayName, domainGUID, domainGUIDs, dqBaseDatasetRule, dqBaseDatasetRules, dqReferenceDatasetRule, dqReferenceDatasetRules, file, files, hasContract, hasLineage, iconUrl, immediateDownstream, immediateUpstream, inputPortDataProduct, inputPortDataProducts, isAIGenerated, isDiscoverable, isEditable, isIncomplete, isPartial, lastRowChangedAt, lastSyncRun, lastSyncRunAt, lastSyncWorkflowName, lexicographicalSortOrder, link, links, mcIncident, mcIncidents, mcMonitor, mcMonitors, meaning, meaningName, meaningNames, meanings, metric, metrics, name, nonCompliantAssetPolicyGUID, nonCompliantAssetPolicyGUIDs, nullField, nullFields, outputPortDataProduct, outputPortDataProducts, outputProductGUID, outputProductGUIDs, ownerGroup, ownerGroups, ownerUser, ownerUsers, pendingTask, pendingTasks, popularityScore, productGUID, productGUIDs, qualifiedName, readme, removeAnnouncement, removeAssignedTerm, removeAssignedTerms, removeAtlanTag, removeAtlanTags, removeAtlanTags, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeUserDescription, sampleDataUrl, schemaRegistrySubject, schemaRegistrySubjects, sodaCheck, sodaChecks, sourceCostUnit, sourceCreatedAt, sourceCreatedBy, sourceEmbedURL, sourceLastReadAt, sourceOwners, sourceQueryComputeCost, sourceQueryComputeCostRecord, sourceQueryComputeCostRecords, sourceQueryComputeCosts, sourceReadCount, sourceReadExpensiveQueryRecord, sourceReadExpensiveQueryRecords, sourceReadPopularQueryRecord, sourceReadPopularQueryRecords, sourceReadQueryCost, sourceReadRecentUser, sourceReadRecentUserRecord, sourceReadRecentUserRecords, sourceReadRecentUsers, sourceReadSlowQueryRecord, sourceReadSlowQueryRecords, sourceReadTopUser, sourceReadTopUserRecord, sourceReadTopUserRecords, sourceReadTopUsers, sourceReadUserCount, sourceTotalCost, sourceUpdatedAt, sourceUpdatedBy, sourceURL, starredBy, starredCount, starredDetail, starredDetails, status, subType, tenantId, updatedBy, updateTime, userDefRelationshipFrom, userDefRelationshipFroms, userDefRelationshipTo, userDefRelationshipTos, userDescription, viewerGroup, viewerGroups, viewerUser, viewerUsers, viewScore

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

clearCustomAttributes, clearLabels, completeObject, customAttribute, customAttributes, displayText, entityStatus, guid, label, labels, relationshipAttributes, relationshipGuid, relationshipStatus, relationshipType, semantic, uniqueAttributes

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

rawJsonObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PurposeBuilder

public PurposeBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class Asset.AssetBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for Purposes.

Overrides:

typeName in class Reference.ReferenceBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>

Returns:

this.

channelLink

public B channelLink(String channelLink)

TBC

Returns:

this.

defaultNavigation

public B defaultNavigation(String defaultNavigation)

TBC

Returns:

this.

denyAssetFilter

public B denyAssetFilter(AssetFilterGroup denyAssetFilter)

denyAssetFilters

public B denyAssetFilters(Collection<? extends AssetFilterGroup> denyAssetFilters)

clearDenyAssetFilters

public B clearDenyAssetFilters()

denyAssetMetadataType

public B denyAssetMetadataType(String denyAssetMetadataType)

denyAssetMetadataTypes

public B denyAssetMetadataTypes(Collection<? extends String> denyAssetMetadataTypes)

clearDenyAssetMetadataTypes

public B clearDenyAssetMetadataTypes()

denyAssetTab

public B denyAssetTab(AssetSidebarTab denyAssetTab)

denyAssetTabs

public B denyAssetTabs(Collection<? extends AssetSidebarTab> denyAssetTabs)

clearDenyAssetTabs

public B clearDenyAssetTabs()

denyAssetType

public B denyAssetType(String denyAssetType)

denyAssetTypes

public B denyAssetTypes(Collection<? extends String> denyAssetTypes)

clearDenyAssetTypes

public B clearDenyAssetTypes()

denyCustomMetadataGuid

public B denyCustomMetadataGuid(String denyCustomMetadataGuid)

denyCustomMetadataGuids

public B denyCustomMetadataGuids(Collection<? extends String> denyCustomMetadataGuids)

clearDenyCustomMetadataGuids

public B clearDenyCustomMetadataGuids()

denyNavigationPage

public B denyNavigationPage(String denyNavigationPage)

denyNavigationPages

public B denyNavigationPages(Collection<? extends String> denyNavigationPages)

clearDenyNavigationPages

public B clearDenyNavigationPages()

denySidebarTab

public B denySidebarTab(String denySidebarTab)

denySidebarTabs

public B denySidebarTabs(Collection<? extends String> denySidebarTabs)

clearDenySidebarTabs

public B clearDenySidebarTabs()

displayPreference

public B displayPreference(String displayPreference)

displayPreferences

public B displayPreferences(Collection<? extends String> displayPreferences)

clearDisplayPreferences

public B clearDisplayPreferences()

isAccessControlEnabled

public B isAccessControlEnabled(Boolean isAccessControlEnabled)

TBC

Returns:

this.

policy

public B policy(IAuthPolicy policy)

policies

public B policies(Collection<? extends IAuthPolicy> policies)

clearPolicies

public B clearPolicies()

purposeAtlanTag

public B purposeAtlanTag(String purposeAtlanTag)

purposeAtlanTags

public B purposeAtlanTags(Collection<? extends String> purposeAtlanTags)

clearPurposeAtlanTags

public B clearPurposeAtlanTags()

self

protected abstract B self()

Specified by:

self in class Asset.AssetBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Asset.AssetBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Asset.AssetBuilder<C extends Purpose,B extends Purpose.PurposeBuilder<C,B>>