Package com.atlan.model.assets

Class APIObject

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.relations.Reference

com.atlan.model.assets.Asset

com.atlan.model.assets.APIObject

All Implemented Interfaces:

IAPI, IAPIObject, IAsset, ICatalog, IReferenceable, AuditDetail, Serializable, Comparable<Reference>

@Generated("com.atlan.generators.ModelGeneratorV2")
public class APIObject
extends Asset
implements IAPIObject, IAPI, ICatalog, IAsset, IReferenceable

Instances of APIObject in Atlan.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	APIObject.APIObjectBuilder<C extends APIObject,B extends APIObject.APIObjectBuilder<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.IAPI

API_EXTERNAL_DOCS, API_IS_AUTH_OPTIONAL, API_IS_OBJECT_REFERENCE, API_OBJECT_QUALIFIED_NAME, API_SPEC_NAME, API_SPEC_QUALIFIED_NAME, API_SPEC_TYPE, API_SPEC_VERSION

Fields inherited from interface com.atlan.model.assets.IAPIObject

API_FIELD_COUNT, API_FIELDS

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, APPLICATION, APPLICATION_FIELD, APPLICATION_FIELD_QUALIFIED_NAME, APPLICATION_QUALIFIED_NAME, 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_DQ_FRESHNESS_EXPECTATION, ASSET_DQ_FRESHNESS_VALUE, ASSET_DQ_RESULT, ASSET_DQ_ROW_SCOPE_FILTER_COLUMN_QUALIFIED_NAME, ASSET_DQ_RULE_ATTACHED_DIMENSIONS, ASSET_DQ_RULE_ATTACHED_RULE_TYPES, ASSET_DQ_RULE_FAILED_COUNT, ASSET_DQ_RULE_FAILED_DIMENSIONS, ASSET_DQ_RULE_FAILED_RULE_TYPES, ASSET_DQ_RULE_LAST_RUN_AT, ASSET_DQ_RULE_PASSED_COUNT, ASSET_DQ_RULE_PASSED_DIMENSIONS, ASSET_DQ_RULE_PASSED_RULE_TYPES, ASSET_DQ_RULE_RESULT_TAGS, ASSET_DQ_RULE_TOTAL_COUNT, ASSET_DQ_SCHEDULE_CRONTAB, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_CODE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_ERROR_MESSAGE, ASSET_DQ_SCHEDULE_SOURCE_SYNC_RAW_ERROR, ASSET_DQ_SCHEDULE_SOURCE_SYNC_STATUS, ASSET_DQ_SCHEDULE_SOURCE_SYNCED_AT, ASSET_DQ_SCHEDULE_TIME_ZONE, ASSET_DQ_SCHEDULE_TYPE, ASSET_EXTERNAL_DQ_METADATA_DETAILS, ASSET_ICON, ASSET_INTERNAL_POPULARITY_SCORE, 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_IS_MONITORED, 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_REDIRECT_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_SOURCE_README, ASSET_SPACE_NAME, ASSET_SPACE_QUALIFIED_NAME, ASSET_TAGS, ASSET_THEME_HEX, ASSET_USER_DEFINED_TYPE, CERTIFICATE_STATUS, CERTIFICATE_STATUS_MESSAGE, CERTIFICATE_UPDATED_AT, CERTIFICATE_UPDATED_BY, CONNECTION_NAME, CONNECTION_QUALIFIED_NAME, CONNECTOR_NAME, CONNECTOR_TYPE, CUSTOM_CONNECTOR_TYPE, DATA_CONTRACT_LATEST, DATA_CONTRACT_LATEST_CERTIFIED, DBT_QUALIFIED_NAME, DESCRIPTION, DISPLAY_NAME, DOMAIN_GUIDS, DQ_BASE_DATASET_RULES, DQ_REFERENCE_DATASET_RULES, 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, OUTPUT_PRODUCT_GUIDS, OWNER_GROUPS, OWNER_USERS, POPULARITY_SCORE, PRODUCT_GUIDS, 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.ICatalog

INPUT_TO_AIRFLOW_TASKS, INPUT_TO_PROCESSES, INPUT_TO_SPARK_JOBS, MODEL_IMPLEMENTED_ATTRIBUTES, MODEL_IMPLEMENTED_ENTITIES, OUTPUT_FROM_AIRFLOW_TASKS, OUTPUT_FROM_PROCESSES, OUTPUT_FROM_SPARK_JOBS

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	APIObject(APIObject.APIObjectBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static APIObject.APIObjectBuilder<?,?>	_internal()
static APIObject	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List)
static APIObject	appendAtlanTags(AtlanClient client, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation)	Deprecated. see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)
static APIObject	appendTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static APIObject	get(AtlanClient client, String id)	Retrieves a APIObject by one of its identifiers, complete with all of its relationships.
static APIObject	get(AtlanClient client, String id, boolean includeAllRelationships)	Retrieves a APIObject by one of its identifiers, optionally complete with all of its relationships.
static APIObject	get(AtlanClient client, String id, Collection<AtlanField> attributes)	Retrieves a APIObject by one of its identifiers, with only the requested attributes (and relationships).
static APIObject	get(AtlanClient client, String id, Collection<AtlanField> attributes, Collection<AtlanField> attributesOnRelated)	Retrieves a APIObject by one of its identifiers, with only the requested attributes (and relationships).
Map<String,String>	getApiExternalDocs()	External documentation of the API.
Long	getApiFieldCount()	Count of the APIField of this object.
SortedSet<IAPIField>	getApiFields()	APIField assets contained within this APIObject.
Boolean	getApiIsAuthOptional()	Whether authentication is optional (true) or required (false).
Boolean	getApiIsObjectReference()	If this asset refers to an APIObject
String	getApiObjectQualifiedName()	Qualified name of the APIObject that is referred to by this asset.
String	getApiSpecName()	Simple name of the API spec, if this asset is contained in an API spec.
String	getApiSpecQualifiedName()	Unique name of the API spec, if this asset is contained in an API spec.
String	getApiSpecType()	Type of API, for example: OpenAPI, GraphQL, etc.
String	getApiSpecVersion()	Version of the API specification.
SortedSet<IAirflowTask>	getInputToAirflowTasks()	Tasks to which this asset provides input.
SortedSet<ILineageProcess>	getInputToProcesses()	Processes to which this asset provides input.
SortedSet<ISparkJob>	getInputToSparkJobs()	TBC
SortedSet<IModelAttribute>	getModelImplementedAttributes()	Attributes implemented by this asset.
SortedSet<IModelEntity>	getModelImplementedEntities()	Entities implemented by this asset.
SortedSet<IAirflowTask>	getOutputFromAirflowTasks()	Tasks from which this asset is output.
SortedSet<ILineageProcess>	getOutputFromProcesses()	Processes from which this asset is produced as output.
SortedSet<ISparkJob>	getOutputFromSparkJobs()	TBC
String	getTypeName()	Fixed typeName for APIObjects.
int	hashCode()
static APIObject	refByGuid(String guid)	Reference to a APIObject by GUID.
static APIObject	refByGuid(String guid, Reference.SaveSemantic semantic)	Reference to a APIObject by GUID.
static APIObject	refByQualifiedName(String qualifiedName)	Reference to a APIObject by qualifiedName.
static APIObject	refByQualifiedName(String qualifiedName, Reference.SaveSemantic semantic)	Reference to a APIObject by qualifiedName.
static APIObject	removeAnnouncement(AtlanClient client, String qualifiedName, String name)	Remove the announcement from a APIObject.
static void	removeAtlanTag(AtlanClient client, String qualifiedName, String atlanTagName)	Deprecated. see Asset.AssetBuilder.removeAtlanTag(String)
static APIObject	removeCertificate(AtlanClient client, String qualifiedName, String name)	Remove the certificate from a APIObject.
static APIObject	removeDescription(AtlanClient client, String qualifiedName, String name)	Remove the system description from a APIObject.
static APIObject	removeOwners(AtlanClient client, String qualifiedName, String name)	Remove the owners from a APIObject.
static APIObject	removeTerms(AtlanClient client, String qualifiedName, List<IGlossaryTerm> terms)	Deprecated. see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)
static APIObject	removeUserDescription(AtlanClient client, String qualifiedName, String name)	Remove the user's description from a APIObject.
static APIObject	replaceTerms(AtlanClient client, String qualifiedName, String name, List<IGlossaryTerm> terms)	Replace the terms linked to the APIObject.
static boolean	restore(AtlanClient client, String qualifiedName)	Restore the archived (soft-deleted) APIObject to active.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client)	Start a fluent search that will return all APIObject assets.
static FluentSearch.FluentSearchBuilder<?,?>	select(AtlanClient client, boolean includeArchived)	Start a fluent search that will return all APIObject assets.
APIObject.APIObjectBuilder<?,?>	toBuilder()
String	toString()
APIObject	trimToReference()	Builds the minimal object necessary to create a relationship to a APIObject, from a potentially more-complete APIObject object.
APIObject.APIObjectBuilder<?,?>	trimToRequired()	Builds the minimal object necessary to apply an update to a APIObject, from a potentially more-complete APIObject object.
static APIObject	updateAnnouncement(AtlanClient client, String qualifiedName, AtlanAnnouncementType type, String title, String message)	Update the announcement on a APIObject.
static APIObject	updateCertificate(AtlanClient client, String qualifiedName, CertificateStatus certificate, String message)	Update the certificate on a APIObject.
static APIObject.APIObjectBuilder<?,?>	updater(String qualifiedName, String name)	Builds the minimal object necessary to update a APIObject.

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

addApiTokenAsAdmin, appendAtlanTags, appendAtlanTags, appendTerms, delete, get, getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getAtlanTagNames, getAtlanTags, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCreatedBy, getCreateTime, getCustomConnectorType, getCustomMetadata, getCustomMetadataSets, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDeleteHandler, getDepth, getDescription, getDisplayName, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getFiles, getHasContract, getHasLineage, getIconUrl, getImmediateDownstream, getImmediateUpstream, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsIncomplete, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMeaningNames, getMeanings, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getNullFields, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPendingTasks, getPopularityScore, getProductGUIDs, 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, purge, removeAnnouncement, removeAtlanTag, removeCertificate, removeCustomMetadata, removeDescription, removeOwners, removeTerms, removeUserDescription, replaceCustomMetadata, replaceTerms, requestLineage, restore, save, save, saveMergingCM, saveMergingCM, saveReplacingCM, saveReplacingCM, updateAnnouncement, updateAnnouncement, updateCertificate, updateCertificate, 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.IAPI

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, 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.IAPIObject

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, 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.IAsset

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, 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.ICatalog

getAdminGroups, getAdminRoles, getAdminUsers, getAnnouncementMessage, getAnnouncementTitle, getAnnouncementType, getAnnouncementUpdatedAt, getAnnouncementUpdatedBy, getAnomaloChecks, getApplication, getApplicationField, getApplicationFieldQualifiedName, getApplicationQualifiedName, 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, getAssetDQFreshnessExpectation, getAssetDQFreshnessValue, getAssetDQResult, getAssetDQRowScopeFilterColumnQualifiedName, getAssetDQRuleAttachedDimensions, getAssetDQRuleAttachedRuleTypes, getAssetDQRuleFailedCount, getAssetDQRuleFailedDimensions, getAssetDQRuleFailedRuleTypes, getAssetDQRuleLastRunAt, getAssetDQRulePassedCount, getAssetDQRulePassedDimensions, getAssetDQRulePassedRuleTypes, getAssetDQRuleResultTags, getAssetDQRuleTotalCount, getAssetDQScheduleCrontab, getAssetDQScheduleSourceSyncedAt, getAssetDQScheduleSourceSyncErrorCode, getAssetDQScheduleSourceSyncErrorMessage, getAssetDQScheduleSourceSyncRawError, getAssetDQScheduleSourceSyncStatus, getAssetDQScheduleTimeZone, getAssetDQScheduleType, getAssetExternalDQMetadataDetails, getAssetIcon, getAssetInternalPopularityScore, getAssetMcAlertQualifiedNames, getAssetMcIncidentNames, getAssetMcIncidentPriorities, getAssetMcIncidentQualifiedNames, getAssetMcIncidentSeverities, getAssetMcIncidentStates, getAssetMcIncidentSubTypes, getAssetMcIncidentTypes, getAssetMcIsMonitored, getAssetMcLastSyncRunAt, getAssetMcMonitorNames, getAssetMcMonitorQualifiedNames, getAssetMcMonitorScheduleTypes, getAssetMcMonitorStatuses, getAssetMcMonitorTypes, getAssetPoliciesCount, getAssetPolicyGUIDs, getAssetRedirectGUIDs, getAssetSodaCheckCount, getAssetSodaCheckStatuses, getAssetSodaDQStatus, getAssetSodaLastScanAt, getAssetSodaLastSyncRunAt, getAssetSodaSourceURL, getAssetSourceReadme, getAssetSpaceName, getAssetSpaceQualifiedName, getAssetTags, getAssetThemeHex, getAssetUserDefinedType, getAssignedTerms, getCertificateStatus, getCertificateStatusMessage, getCertificateUpdatedAt, getCertificateUpdatedBy, getConnectionName, getConnectionQualifiedName, getConnectorName, getConnectorType, getCustomConnectorType, getDataContractLatest, getDataContractLatestCertified, getDbtQualifiedName, getDescription, getDisplayName, getDisplayText, getDomainGUIDs, getDqBaseDatasetRules, getDqReferenceDatasetRules, getEntityStatus, getFiles, getGuid, getHasContract, getHasLineage, getIconUrl, getInputPortDataProducts, getIsAIGenerated, getIsDiscoverable, getIsEditable, getIsPartial, getLastRowChangedAt, getLastSyncRun, getLastSyncRunAt, getLastSyncWorkflowName, getLexicographicalSortOrder, getLinks, getMcIncidents, getMcMonitors, getMetrics, getName, getNonCompliantAssetPolicyGUIDs, getOutputPortDataProducts, getOutputProductGUIDs, getOwnerGroups, getOwnerUsers, getPopularityScore, getProductGUIDs, 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

APIObject

protected APIObject(APIObject.APIObjectBuilder<?,?> b)

Method Details

trimToReference

public APIObject trimToReference()
                          throws InvalidRequestException

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

Overrides:

trimToReference in class Asset

Returns:

the minimal object necessary to relate to the APIObject

Throws:

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

select

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

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

Parameters:

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

Returns:

a fluent search that includes all APIObject assets

select

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

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

Returns:

a fluent search that includes all APIObject assets

refByGuid

public static APIObject refByGuid(String guid)

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

Parameters:

guid - the GUID of the APIObject to reference

Returns:

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

refByGuid

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

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

Parameters:

guid - the GUID of the APIObject to reference

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

Returns:

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

refByQualifiedName

public static APIObject refByQualifiedName(String qualifiedName)

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

Parameters:

qualifiedName - the qualifiedName of the APIObject to reference

Returns:

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

refByQualifiedName

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

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

Parameters:

qualifiedName - the qualifiedName of the APIObject to reference

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

Returns:

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

get

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

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

Returns:

the requested full APIObject, complete with all of its relationships

Throws:

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

get

public static APIObject get(AtlanClient client,
 String id,
 boolean includeAllRelationships)
                     throws AtlanException

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

includeAllRelationships - if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved

Returns:

the requested full APIObject, optionally complete with all of its relationships

Throws:

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

get

public static APIObject get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes)
                     throws AtlanException

Retrieves a APIObject by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

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

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

attributes - to retrieve for the APIObject, including any relationships

Returns:

the requested APIObject, with only its minimal information and the requested attributes (and relationships)

Throws:

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

get

public static APIObject get(AtlanClient client,
 String id,
 Collection<AtlanField> attributes,
 Collection<AtlanField> attributesOnRelated)
                     throws AtlanException

Retrieves a APIObject by one of its identifiers, with only the requested attributes (and relationships).

Parameters:

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

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

attributes - to retrieve for the APIObject, including any relationships

attributesOnRelated - to retrieve on each relationship retrieved for the APIObject

Returns:

the requested APIObject, with only its minimal information and the requested attributes (and relationships)

Throws:

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

restore

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

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

Parameters:

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

qualifiedName - for the APIObject

Returns:

true if the APIObject is now active, and false otherwise

Throws:

AtlanException - on any API problems

updater

public static APIObject.APIObjectBuilder<?,?> updater(String qualifiedName,
 String name)

Builds the minimal object necessary to update a APIObject.

Parameters:

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the minimal request necessary to update the APIObject, as a builder

trimToRequired

public APIObject.APIObjectBuilder<?,?> trimToRequired()
                                               throws InvalidRequestException

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

Overrides:

trimToRequired in class Asset

Returns:

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

Throws:

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

removeDescription

public static APIObject removeDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                   throws AtlanException

Remove the system description from a APIObject.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the updated APIObject, or null if the removal failed

Throws:

AtlanException - on any API problems

removeUserDescription

public static APIObject removeUserDescription(AtlanClient client,
 String qualifiedName,
 String name)
                                       throws AtlanException

Remove the user's description from a APIObject.

Parameters:

client - connectivity to the Atlan tenant on which to remove the asset's description

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the updated APIObject, or null if the removal failed

Throws:

AtlanException - on any API problems

removeOwners

public static APIObject removeOwners(AtlanClient client,
 String qualifiedName,
 String name)
                              throws AtlanException

Remove the owners from a APIObject.

Parameters:

client - connectivity to the Atlan tenant from which to remove the APIObject's owners

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the updated APIObject, or null if the removal failed

Throws:

AtlanException - on any API problems

updateCertificate

public static APIObject updateCertificate(AtlanClient client,
 String qualifiedName,
 CertificateStatus certificate,
 String message)
                                   throws AtlanException

Update the certificate on a APIObject.

Parameters:

client - connectivity to the Atlan tenant on which to update the APIObject's certificate

qualifiedName - of the APIObject

certificate - to use

message - (optional) message, or null if no message

Returns:

the updated APIObject, or null if the update failed

Throws:

AtlanException - on any API problems

removeCertificate

public static APIObject removeCertificate(AtlanClient client,
 String qualifiedName,
 String name)
                                   throws AtlanException

Remove the certificate from a APIObject.

Parameters:

client - connectivity to the Atlan tenant from which to remove the APIObject's certificate

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the updated APIObject, or null if the removal failed

Throws:

AtlanException - on any API problems

updateAnnouncement

public static APIObject updateAnnouncement(AtlanClient client,
 String qualifiedName,
 AtlanAnnouncementType type,
 String title,
 String message)
                                    throws AtlanException

Update the announcement on a APIObject.

Parameters:

client - connectivity to the Atlan tenant on which to update the APIObject's announcement

qualifiedName - of the APIObject

type - type of announcement to set

title - (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 APIObject removeAnnouncement(AtlanClient client,
 String qualifiedName,
 String name)
                                    throws AtlanException

Remove the announcement from a APIObject.

Parameters:

client - connectivity to the Atlan client from which to remove the APIObject's announcement

qualifiedName - of the APIObject

name - of the APIObject

Returns:

the updated APIObject, or null if the removal failed

Throws:

AtlanException - on any API problems

replaceTerms

public static APIObject replaceTerms(AtlanClient client,
 String qualifiedName,
 String name,
 List<IGlossaryTerm> terms)
                              throws AtlanException

Replace the terms linked to the APIObject.

Parameters:

client - connectivity to the Atlan tenant on which to replace the APIObject's assigned terms

qualifiedName - for the APIObject

name - human-readable name of the APIObject

terms - the list of terms to replace on the APIObject, or null to remove all terms from the APIObject

Returns:

the APIObject that was updated (note that it will NOT contain details of the replaced terms)

Throws:

AtlanException - on any API problems

appendTerms

@Deprecated
public static APIObject appendTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                             throws AtlanException

Deprecated.

see Asset.AssetBuilder.appendAssignedTerm(GlossaryTerm)

Link additional terms to the APIObject, without replacing existing terms linked to the APIObject. Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject

qualifiedName - for the APIObject

terms - the list of terms to append to the APIObject

Returns:

the APIObject that was updated (note that it will NOT contain details of the appended terms)

Throws:

AtlanException - on any API problems

removeTerms

@Deprecated
public static APIObject removeTerms(AtlanClient client,
 String qualifiedName,
 List<IGlossaryTerm> terms)
                             throws AtlanException

Deprecated.

see Asset.AssetBuilder.removeAssignedTerm(GlossaryTerm)

Remove terms from a APIObject, without replacing all existing terms linked to the APIObject. Note: this operation must make two API calls — one to retrieve the APIObject'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 APIObject

qualifiedName - for the APIObject

terms - the list of terms to remove from the APIObject, which must be referenced by GUID

Returns:

the APIObject that was updated (note that it will NOT contain details of the resulting terms)

Throws:

AtlanException - on any API problems

appendAtlanTags

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

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List)

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

qualifiedName - of the APIObject

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

Returns:

the updated APIObject

Throws:

AtlanException - on any API problems

appendAtlanTags

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

Deprecated.

see Asset.AssetBuilder.appendAtlanTags(List, boolean, boolean, boolean, boolean)

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

qualifiedName - of the APIObject

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 APIObject

Throws:

AtlanException - on any API problems

removeAtlanTag

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

Deprecated.

see Asset.AssetBuilder.removeAtlanTag(String)

Remove an Atlan tag from a APIObject.

Parameters:

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

qualifiedName - of the APIObject

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 APIObject

_internal

public static APIObject.APIObjectBuilder<?,?> _internal()

toBuilder

public APIObject.APIObjectBuilder<?,?> toBuilder()

Overrides:

toBuilder in class Reference

getApiExternalDocs

public Map<String,String> getApiExternalDocs()

External documentation of the API.

Specified by:

getApiExternalDocs in interface IAPI

Specified by:

getApiExternalDocs in interface IAPIObject

getApiFieldCount

public Long getApiFieldCount()

Count of the APIField of this object.

Specified by:

getApiFieldCount in interface IAPIObject

getApiFields

public SortedSet<IAPIField> getApiFields()

APIField assets contained within this APIObject.

Specified by:

getApiFields in interface IAPIObject

getApiIsAuthOptional

public Boolean getApiIsAuthOptional()

Whether authentication is optional (true) or required (false).

Specified by:

getApiIsAuthOptional in interface IAPI

Specified by:

getApiIsAuthOptional in interface IAPIObject

getApiIsObjectReference

public Boolean getApiIsObjectReference()

If this asset refers to an APIObject

Specified by:

getApiIsObjectReference in interface IAPI

Specified by:

getApiIsObjectReference in interface IAPIObject

getApiObjectQualifiedName

public String getApiObjectQualifiedName()

Qualified name of the APIObject that is referred to by this asset. When apiIsObjectReference is true.

Specified by:

getApiObjectQualifiedName in interface IAPI

Specified by:

getApiObjectQualifiedName in interface IAPIObject

getApiSpecName

public String getApiSpecName()

Simple name of the API spec, if this asset is contained in an API spec.

Specified by:

getApiSpecName in interface IAPI

Specified by:

getApiSpecName in interface IAPIObject

getApiSpecQualifiedName

public String getApiSpecQualifiedName()

Unique name of the API spec, if this asset is contained in an API spec.

Specified by:

getApiSpecQualifiedName in interface IAPI

Specified by:

getApiSpecQualifiedName in interface IAPIObject

getApiSpecType

public String getApiSpecType()

Type of API, for example: OpenAPI, GraphQL, etc.

Specified by:

getApiSpecType in interface IAPI

Specified by:

getApiSpecType in interface IAPIObject

getApiSpecVersion

public String getApiSpecVersion()

Version of the API specification.

Specified by:

getApiSpecVersion in interface IAPI

Specified by:

getApiSpecVersion in interface IAPIObject

getInputToAirflowTasks

public SortedSet<IAirflowTask> getInputToAirflowTasks()

Tasks to which this asset provides input.

Specified by:

getInputToAirflowTasks in interface IAPI

Specified by:

getInputToAirflowTasks in interface IAPIObject

Specified by:

getInputToAirflowTasks in interface ICatalog

getInputToProcesses

public SortedSet<ILineageProcess> getInputToProcesses()

Processes to which this asset provides input.

Specified by:

getInputToProcesses in interface IAPI

Specified by:

getInputToProcesses in interface IAPIObject

Specified by:

getInputToProcesses in interface ICatalog

getInputToSparkJobs

public SortedSet<ISparkJob> getInputToSparkJobs()

TBC

Specified by:

getInputToSparkJobs in interface IAPI

Specified by:

getInputToSparkJobs in interface IAPIObject

Specified by:

getInputToSparkJobs in interface ICatalog

getModelImplementedAttributes

public SortedSet<IModelAttribute> getModelImplementedAttributes()

Attributes implemented by this asset.

Specified by:

getModelImplementedAttributes in interface IAPI

Specified by:

getModelImplementedAttributes in interface IAPIObject

Specified by:

getModelImplementedAttributes in interface ICatalog

getModelImplementedEntities

public SortedSet<IModelEntity> getModelImplementedEntities()

Entities implemented by this asset.

Specified by:

getModelImplementedEntities in interface IAPI

Specified by:

getModelImplementedEntities in interface IAPIObject

Specified by:

getModelImplementedEntities in interface ICatalog

getOutputFromAirflowTasks

public SortedSet<IAirflowTask> getOutputFromAirflowTasks()

Tasks from which this asset is output.

Specified by:

getOutputFromAirflowTasks in interface IAPI

Specified by:

getOutputFromAirflowTasks in interface IAPIObject

Specified by:

getOutputFromAirflowTasks in interface ICatalog

getOutputFromProcesses

public SortedSet<ILineageProcess> getOutputFromProcesses()

Processes from which this asset is produced as output.

Specified by:

getOutputFromProcesses in interface IAPI

Specified by:

getOutputFromProcesses in interface IAPIObject

Specified by:

getOutputFromProcesses in interface ICatalog

getOutputFromSparkJobs

public SortedSet<ISparkJob> getOutputFromSparkJobs()

TBC

Specified by:

getOutputFromSparkJobs in interface IAPI

Specified by:

getOutputFromSparkJobs in interface IAPIObject

Specified by:

getOutputFromSparkJobs in interface ICatalog

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

Specified by:

getTypeName in interface AuditDetail

Specified by:

getTypeName in interface IAPI

Specified by:

getTypeName in interface IAPIObject

Specified by:

getTypeName in interface IAsset

Specified by:

getTypeName in interface ICatalog

Specified by:

getTypeName in interface IReferenceable

Overrides:

getTypeName in class Reference