Package com.atlan.model.assets

Class SemanticField.SemanticFieldBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<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.SemanticField.SemanticFieldBuilder<C,B>

Enclosing class:

SemanticField

public abstract static class SemanticField.SemanticFieldBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>
extends Asset.AssetBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
SemanticFieldBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
abstract C	build()
B	clearInputToAirflowTasks()
B	clearInputToProcesses()
B	clearInputToSparkJobs()
B	clearModelImplementedAttributes()
B	clearModelImplementedEntities()
B	clearOutputFromAirflowTasks()
B	clearOutputFromProcesses()
B	clearOutputFromSparkJobs()
B	clearPartialChildFields()
B	clearPartialChildObjects()
B	clearSemanticLabels()
B	clearSemanticSampleValues()
B	clearSemanticSynonyms()
B	inputToAirflowTask(IAirflowTask inputToAirflowTask)
B	inputToAirflowTasks(Collection<? extends IAirflowTask> inputToAirflowTasks)
B	inputToProcess(ILineageProcess inputToProcess)
B	inputToProcesses(Collection<? extends ILineageProcess> inputToProcesses)
B	inputToSparkJob(ISparkJob inputToSparkJob)
B	inputToSparkJobs(Collection<? extends ISparkJob> inputToSparkJobs)
B	modelImplementedAttribute(IModelAttribute modelImplementedAttribute)
B	modelImplementedAttributes(Collection<? extends IModelAttribute> modelImplementedAttributes)
B	modelImplementedEntities(Collection<? extends IModelEntity> modelImplementedEntities)
B	modelImplementedEntity(IModelEntity modelImplementedEntity)
B	outputFromAirflowTask(IAirflowTask outputFromAirflowTask)
B	outputFromAirflowTasks(Collection<? extends IAirflowTask> outputFromAirflowTasks)
B	outputFromProcess(ILineageProcess outputFromProcess)
B	outputFromProcesses(Collection<? extends ILineageProcess> outputFromProcesses)
B	outputFromSparkJob(ISparkJob outputFromSparkJob)
B	outputFromSparkJobs(Collection<? extends ISparkJob> outputFromSparkJobs)
B	partialChildField(IPartialField partialChildField)
B	partialChildFields(Collection<? extends IPartialField> partialChildFields)
B	partialChildObject(IPartialObject partialChildObject)
B	partialChildObjects(Collection<? extends IPartialObject> partialChildObjects)
protected abstract B	self()
B	semanticAccessModifier(String semanticAccessModifier)	Access level for the semantic field (e.g., public_access/private_access).
B	semanticDataType(String semanticDataType)	Data type of the semantic field.
B	semanticExpression(String semanticExpression)	Column name or SQL expression for the semantic field.
B	semanticLabel(String semanticLabel)
B	semanticLabels(Collection<? extends String> semanticLabels)
B	semanticSampleValue(String semanticSampleValue)
B	semanticSampleValues(Collection<? extends String> semanticSampleValues)
B	semanticSynonym(String semanticSynonym)
B	semanticSynonyms(Collection<? extends String> semanticSynonyms)
B	semanticType(String semanticType)	Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).
String	toString()
B	typeName(String typeName)	Fixed typeName for SemanticFields.

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

addAssetGCPDataplexAspect, addAssetGCPDataplexAspectField, addStarredBy, adminGroup, adminGroups, adminRole, adminRoles, adminUser, adminUsers, announcementMessage, announcementTitle, announcementType, announcementUpdatedAt, announcementUpdatedBy, anomaloCheck, anomaloChecks, appendAssignedTerm, appendAtlanTag, appendAtlanTag, appendAtlanTags, appendAtlanTags, application, applicationField, applicationFieldQualifiedName, applicationQualifiedName, assetAiGeneratedDescription, assetAiGeneratedDescriptionConfidence, assetAiGeneratedDescriptionReasoning, assetAnnouncementExpiredAt, 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, assetDQManualRunStatus, 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, assetGCPDataplexAspectFieldList, assetGCPDataplexAspectList, assetGCPDataplexMetadataDetails, 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, assetSmusMetadataFormDetail, assetSmusMetadataFormDetails, assetSmusMetadataFormKeyValueDetail, assetSmusMetadataFormKeyValueDetails, assetSmusMetadataFormName, assetSmusMetadataFormNames, assetSodaCheckCount, assetSodaCheckStatuses, assetSodaDQStatus, assetSodaLastScanAt, assetSodaLastSyncRunAt, assetSodaSourceURL, assetSourceId, 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, clearAssetGCPDataplexAspectFieldList, clearAssetGCPDataplexAspectList, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetRedirectGUIDs, clearAssetSmusMetadataFormDetails, clearAssetSmusMetadataFormKeyValueDetails, clearAssetSmusMetadataFormNames, 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

addedRelationshipAttributes, clearCustomAttributes, clearLabels, completeObject, customAttribute, customAttributes, displayText, docId, entityStatus, guid, label, labels, relationshipAttributes, relationshipGuid, relationshipStatus, relationshipType, removedRelationshipAttributes, 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

SemanticFieldBuilder

public SemanticFieldBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class Asset.AssetBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for SemanticFields.

Overrides:

typeName in class Reference.ReferenceBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>

Returns:

this.

inputToAirflowTask

public B inputToAirflowTask(IAirflowTask inputToAirflowTask)

inputToAirflowTasks

public B inputToAirflowTasks(Collection<? extends IAirflowTask> inputToAirflowTasks)

clearInputToAirflowTasks

public B clearInputToAirflowTasks()

inputToProcess

public B inputToProcess(ILineageProcess inputToProcess)

inputToProcesses

public B inputToProcesses(Collection<? extends ILineageProcess> inputToProcesses)

clearInputToProcesses

public B clearInputToProcesses()

inputToSparkJob

public B inputToSparkJob(ISparkJob inputToSparkJob)

inputToSparkJobs

public B inputToSparkJobs(Collection<? extends ISparkJob> inputToSparkJobs)

clearInputToSparkJobs

public B clearInputToSparkJobs()

modelImplementedAttribute

public B modelImplementedAttribute(IModelAttribute modelImplementedAttribute)

modelImplementedAttributes

public B modelImplementedAttributes(Collection<? extends IModelAttribute> modelImplementedAttributes)

clearModelImplementedAttributes

public B clearModelImplementedAttributes()

modelImplementedEntity

public B modelImplementedEntity(IModelEntity modelImplementedEntity)

modelImplementedEntities

public B modelImplementedEntities(Collection<? extends IModelEntity> modelImplementedEntities)

clearModelImplementedEntities

public B clearModelImplementedEntities()

outputFromAirflowTask

public B outputFromAirflowTask(IAirflowTask outputFromAirflowTask)

outputFromAirflowTasks

public B outputFromAirflowTasks(Collection<? extends IAirflowTask> outputFromAirflowTasks)

clearOutputFromAirflowTasks

public B clearOutputFromAirflowTasks()

outputFromProcess

public B outputFromProcess(ILineageProcess outputFromProcess)

outputFromProcesses

public B outputFromProcesses(Collection<? extends ILineageProcess> outputFromProcesses)

clearOutputFromProcesses

public B clearOutputFromProcesses()

outputFromSparkJob

public B outputFromSparkJob(ISparkJob outputFromSparkJob)

outputFromSparkJobs

public B outputFromSparkJobs(Collection<? extends ISparkJob> outputFromSparkJobs)

clearOutputFromSparkJobs

public B clearOutputFromSparkJobs()

partialChildField

public B partialChildField(IPartialField partialChildField)

partialChildFields

public B partialChildFields(Collection<? extends IPartialField> partialChildFields)

clearPartialChildFields

public B clearPartialChildFields()

partialChildObject

public B partialChildObject(IPartialObject partialChildObject)

partialChildObjects

public B partialChildObjects(Collection<? extends IPartialObject> partialChildObjects)

clearPartialChildObjects

public B clearPartialChildObjects()

semanticAccessModifier

public B semanticAccessModifier(String semanticAccessModifier)

Access level for the semantic field (e.g., public_access/private_access).

Returns:

this.

semanticDataType

public B semanticDataType(String semanticDataType)

Data type of the semantic field.

Returns:

this.

semanticExpression

public B semanticExpression(String semanticExpression)

Column name or SQL expression for the semantic field.

Returns:

this.

semanticLabel

public B semanticLabel(String semanticLabel)

semanticLabels

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

clearSemanticLabels

public B clearSemanticLabels()

semanticSampleValue

public B semanticSampleValue(String semanticSampleValue)

semanticSampleValues

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

clearSemanticSampleValues

public B clearSemanticSampleValues()

semanticSynonym

public B semanticSynonym(String semanticSynonym)

semanticSynonyms

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

clearSemanticSynonyms

public B clearSemanticSynonyms()

semanticType

public B semanticType(String semanticType)

Detailed type of the semantic field (e.g., type of measure, type of dimension, or type of entity).

Returns:

this.

self

protected abstract B self()

Specified by:

self in class Asset.AssetBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Asset.AssetBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Asset.AssetBuilder<C extends SemanticField,B extends SemanticField.SemanticFieldBuilder<C,B>>