Package com.atlan.model.assets

Class Readme.ReadmeBuilder<C extends Readme,B extends Readme.ReadmeBuilder<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.Readme.ReadmeBuilder<C,B>

Enclosing class:

Readme

public abstract static class Readme.ReadmeBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>
extends Asset.AssetBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
ReadmeBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	asset(IAsset asset)	Asset that this README describes.
abstract C	build()
B	clearInputToAirflowTasks()
B	clearInputToProcesses()
B	clearInputToSparkJobs()
B	clearModelImplementedAttributes()
B	clearModelImplementedEntities()
B	clearOutputFromAirflowTasks()
B	clearOutputFromProcesses()
B	clearOutputFromSparkJobs()
B	clearResourceMetadata()
B	clearSeeAlso()
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	isGlobal(Boolean isGlobal)	Whether the resource is global (true) or not (false).
B	link(String link)	URL to the resource.
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	putResourceMetadata(String putResourceMetadataKey, String putResourceMetadataValue)
B	reference(String reference)	Reference to the resource.
B	resourceMetadata(Map<? extends String,? extends String> resourceMetadata)
B	seeAlso(Collection<? extends IReadme> seeAlso)
B	seeAlsoOne(IReadme seeAlsoOne)
protected abstract B	self()
String	toString()
B	typeName(String typeName)	Fixed typeName for Readmes.

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, assetIcon, 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, assetTag, assetTags, assetThemeHex, assignedTerm, assignedTerms, atlanTag, atlanTagName, atlanTagNames, atlanTags, certificateStatus, certificateStatusMessage, certificateUpdatedAt, certificateUpdatedBy, clearAdminGroups, clearAdminRoles, clearAdminUsers, clearAnomaloChecks, clearAssetAnomaloAppliedCheckTypes, clearAssetAnomaloFailedCheckTypes, clearAssetDbtTags, clearAssetMcAlertQualifiedNames, clearAssetMcIncidentNames, clearAssetMcIncidentPriorities, clearAssetMcIncidentQualifiedNames, clearAssetMcIncidentSeverities, clearAssetMcIncidentStates, clearAssetMcIncidentSubTypes, clearAssetMcIncidentTypes, clearAssetMcMonitorNames, clearAssetMcMonitorQualifiedNames, clearAssetMcMonitorScheduleTypes, clearAssetMcMonitorStatuses, clearAssetMcMonitorTypes, clearAssetPolicyGUIDs, clearAssetRedirectGUIDs, clearAssetTags, clearAssignedTerms, clearAtlanTagNames, clearAtlanTags, clearCustomMetadataSets, clearDomainGUIDs, 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, connectorType, createdBy, createTime, customConnectorType, customMetadata, customMetadataSets, dataContractLatest, dataContractLatestCertified, dbtQualifiedName, deleteHandler, depth, description, displayName, domainGUID, domainGUIDs, 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

ReadmeBuilder

public ReadmeBuilder()

Method Details

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class Asset.AssetBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>

typeName

public B typeName(String typeName)

Fixed typeName for Readmes.

Overrides:

typeName in class Reference.ReferenceBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>

Returns:

this.

asset

public B asset(IAsset asset)

Asset that this README describes.

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()

isGlobal

public B isGlobal(Boolean isGlobal)

Whether the resource is global (true) or not (false).

Returns:

this.

link

public B link(String link)

URL to the resource.

Returns:

this.

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()

reference

public B reference(String reference)

Reference to the resource.

Returns:

this.

putResourceMetadata

public B putResourceMetadata(String putResourceMetadataKey,
 String putResourceMetadataValue)

resourceMetadata

public B resourceMetadata(Map<? extends String,? extends String> resourceMetadata)

clearResourceMetadata

public B clearResourceMetadata()

seeAlsoOne

public B seeAlsoOne(IReadme seeAlsoOne)

seeAlso

public B seeAlso(Collection<? extends IReadme> seeAlso)

clearSeeAlso

public B clearSeeAlso()

self

protected abstract B self()

Specified by:

self in class Asset.AssetBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class Asset.AssetBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class Asset.AssetBuilder<C extends Readme,B extends Readme.ReadmeBuilder<C,B>>