Package com.atlan.model.assets
Class Asset
java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.relations.Reference
com.atlan.model.assets.Asset
- All Implemented Interfaces:
IAsset,IReferenceable,AuditDetail,Serializable,Comparable<Reference>
- Direct Known Subclasses:
AdfActivity,AdfDataflow,AdfDataset,AdfLinkedservice,AdfPipeline,ADLSAccount,ADLSContainer,ADLSObject,AIApplication,AIModel,AirflowDag,AirflowTask,AnaplanApp,AnaplanDimension,AnaplanLineItem,AnaplanList,AnaplanModel,AnaplanModule,AnaplanPage,AnaplanSystemDimension,AnaplanView,AnaplanWorkspace,AnomaloCheck,APIField,APIObject,APIPath,APIQuery,APISpec,Application,ApplicationField,AppWorkflowRun,AtlanCollection,AtlanQuery,AuthPolicy,AuthService,AzureEventHub,AzureEventHubConsumerGroup,AzureServiceBusNamespace,AzureServiceBusSchema,AzureServiceBusTopic,Badge,BigqueryRoutine,BigqueryTag,BIProcess,BusinessPolicy,BusinessPolicyException,BusinessPolicyIncident,BusinessPolicyLog,CalculationView,CassandraColumn,CassandraIndex,CassandraKeyspace,CassandraTable,CassandraView,Cognite3DModel,CogniteAsset,CogniteEvent,CogniteFile,CogniteSequence,CogniteTimeSeries,CognosColumn,CognosDashboard,CognosDataset,CognosDatasource,CognosExploration,CognosFile,CognosFolder,CognosModule,CognosPackage,CognosReport,Column,ColumnProcess,Connection,ConnectionProcess,CosmosMongoDBAccount,CosmosMongoDBCollection,CosmosMongoDBDatabase,Cube,CubeDimension,CubeField,CubeHierarchy,CustomEntity,Database,DatabricksAIModelContext,DatabricksAIModelVersion,DatabricksExternalLocation,DatabricksExternalLocationPath,DatabricksNotebook,DatabricksUnityCatalogTag,DatabricksVolume,DatabricksVolumePath,DataContract,DataDomain,DataProduct,DataQualityRule,DataQualityRuleTemplate,DataStudioAsset,DataverseAttribute,DataverseEntity,DbtColumnProcess,DbtMetric,DbtModel,DbtModelColumn,DbtProcess,DbtSeed,DbtSource,DbtTag,DbtTest,DocumentDBCollection,DocumentDBDatabase,DomoCard,DomoDashboard,DomoDataset,DomoDatasetColumn,DremioColumn,DremioFolder,DremioPhysicalDataset,DremioSource,DremioSpace,DremioVirtualDataset,DynamoDBGlobalSecondaryIndex,DynamoDBLocalSecondaryIndex,DynamoDBTable,FabricActivity,FabricDashboard,FabricDataflow,FabricDataflowEntityColumn,FabricDataPipeline,FabricPage,FabricReport,FabricSemanticModel,FabricSemanticModelTable,FabricSemanticModelTableColumn,FabricVisual,FabricWorkspace,File,FivetranConnector,FlowControlOperation,FlowDataset,FlowDatasetOperation,FlowField,FlowFieldOperation,FlowFolder,FlowProject,FlowReusableUnit,Folder,Form,Function,GCSBucket,GCSObject,Glossary,GlossaryCategory,GlossaryTerm,IndistinctAsset,Insight,KafkaConsumerGroup,KafkaTopic,LineageProcess,Link,LookerDashboard,LookerExplore,LookerField,LookerFolder,LookerLook,LookerModel,LookerProject,LookerQuery,LookerTile,LookerView,MaterializedView,MatillionComponent,MatillionGroup,MatillionJob,MatillionProject,MCIncident,MCMonitor,MetabaseCollection,MetabaseDashboard,MetabaseQuestion,MicroStrategyAttribute,MicroStrategyColumn,MicroStrategyCube,MicroStrategyDocument,MicroStrategyDossier,MicroStrategyFact,MicroStrategyMetric,MicroStrategyProject,MicroStrategyReport,MicroStrategyVisualization,ModeChart,ModeCollection,ModelAttribute,ModelAttributeAssociation,ModelDataModel,ModelEntity,ModelEntityAssociation,ModelVersion,ModeQuery,ModeReport,ModeWorkspace,MongoDBCollection,MongoDBDatabase,Persona,PowerBIApp,PowerBIColumn,PowerBIDashboard,PowerBIDataflow,PowerBIDataflowEntityColumn,PowerBIDataset,PowerBIDatasource,PowerBIMeasure,PowerBIPage,PowerBIReport,PowerBITable,PowerBITile,PowerBIWorkspace,PresetChart,PresetDashboard,PresetDataset,PresetWorkspace,Procedure,Purpose,QlikApp,QlikChart,QlikColumn,QlikDataset,QlikSheet,QlikSpace,QlikStream,QuickSightAnalysis,QuickSightAnalysisVisual,QuickSightDashboard,QuickSightDashboardVisual,QuickSightDataset,QuickSightDatasetField,QuickSightFolder,Readme,ReadmeTemplate,RedashDashboard,RedashQuery,RedashVisualization,Response,S3Bucket,S3Object,SalesforceDashboard,SalesforceField,SalesforceObject,SalesforceOrganization,SalesforceReport,SapErpAbapProgram,SapErpCdsView,SapErpColumn,SapErpComponent,SapErpFunctionModule,SapErpTable,SapErpTransactionCode,SapErpView,Schema,SchemaRegistrySubject,SigmaDataElement,SigmaDataElementField,SigmaDataset,SigmaDatasetColumn,SigmaPage,SigmaWorkbook,SisenseDashboard,SisenseDatamodel,SisenseDatamodelTable,SisenseFolder,SisenseWidget,SnowflakeAIModelContext,SnowflakeAIModelVersion,SnowflakeDynamicTable,SnowflakePipe,SnowflakeStage,SnowflakeStream,SnowflakeTag,SodaCheck,SourceTag,SparkJob,Stakeholder,StakeholderTitle,SupersetChart,SupersetDashboard,SupersetDataset,Table,TableauCalculatedField,TableauDashboard,TableauDashboardField,TableauDatasource,TableauDatasourceField,TableauFlow,TableauMetric,TableauProject,TableauSite,TableauWorkbook,TableauWorksheet,TableauWorksheetField,TablePartition,TagAttachment,Task,ThoughtspotAnswer,ThoughtspotColumn,ThoughtspotDashlet,ThoughtspotLiveboard,ThoughtspotTable,ThoughtspotView,ThoughtspotWorksheet,UserDefRelationship.UserDefRelationshipFrom,UserDefRelationship.UserDefRelationshipTo,View,Workflow,WorkflowRun
@Generated("com.atlan.generators.ModelGeneratorV2")
public abstract class Asset
extends Reference
implements IAsset, IReferenceable
Base class for all assets.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAsset.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 inherited from class com.atlan.model.core.AtlanObject
rawJsonObjectFields 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_USERSFields 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, TYPE_NAME, UPDATE_TIME, UPDATED_BY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected static AssetMutationResponseaddApiTokenAsAdmin(AtlanClient client, String assetGuid, String impersonationToken) Add the API token configured for the default client as an admin to this object.protected static AssetappendAtlanTags(AtlanClient client, String typeName, String qualifiedName, List<String> atlanTagNames) Deprecated.protected static AssetappendAtlanTags(AtlanClient client, String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) protected static AssetappendTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.protected booleanstatic AssetDeletionResponsedelete(AtlanClient client, String guid) Soft-deletes an asset by its GUID.booleanstatic Assetget(AtlanClient client, String guid, boolean includeAllRelationships) Retrieves an asset by its GUID, optionally complete with all of its relationships.static Assetget(AtlanClient client, String typeName, String qualifiedName, boolean includeAllRelationships) Retrieves an asset by its qualifiedName, optionally complete with all of its relationships.List of groups who administer this asset.List of roles who administer this asset.List of users who administer this asset.Detailed message to include in the announcement on this asset.Brief title for the announcement on this asset.Type of announcement on this asset.Time (epoch) at which the announcement was last updated, in milliseconds.Name of the user who last updated the announcement.Checks that run on this asset.Application owning the Asset.ApplicationField owning the Asset.Qualified name of the ApplicationField that contains this asset.Qualified name of the Application that contains this asset.All associated Anomalo check types.Total number of checks present in Anomalo for this asset.Stringified JSON object containing status of all Anomalo checks associated to this asset.Status of data quality from Anomalo.Total number of checks failed in Anomalo for this asset.All associated Anomalo failed check types.Time (epoch) at which the last check was run via Anomalo.URL of the source in Anomalo.Cover image to use for this asset in the UI (applicable to only a few asset types).Name of the account in which this asset exists in dbt.Alias of this asset in dbt.Version of the environment in which this asset is materialized in dbt.Name of the environment in which this asset is materialized in dbt.Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.Thread ID of the user who executed the last run of the job that materialized this asset in dbt.Branch in git from which the last run of the job that materialized this asset in dbt ran.SHA hash in git for the last run of the job that materialized this asset in dbt.Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).Thread ID of the owner of the last run of the job that materialized this asset in dbt.Total duration the job that materialized this asset in dbt spent being queued.Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.Run duration of the last run of the job that materialized this asset in dbt.Human-readable run duration of the last run of the job that materialized this asset in dbt.Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.Status message of the last run of the job that materialized this asset in dbt.Total duration of the last run of the job that materialized this asset in dbt.Human-readable total duration of the last run of the job that materialized this asset in dbt.Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.URL of the last run of the job that materialized this asset in dbt.Name of the job that materialized this asset in dbt.Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.Schedule of the job that materialized this asset in dbt.Human-readable cron schedule of the job that materialized this asset in dbt.Status of the job that materialized this asset in dbt.Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.Name of the package in which this asset exists in dbt.Name of the project in which this asset exists in dbt.URL of the semantic layer proxy for this asset in dbt.Freshness criteria for the source of this asset in dbt.List of tags attached to this asset in dbt.All associated dbt test statuses.Unique identifier of this asset in dbt.Name of the DBT workflow in Atlan that last updated the asset.Expectation of data freshness from Source.Value of data freshness from Source.Overall result of all the dq rules.Qualified name of the column used for row scope filtering in DQ rules for this asset.List of all the dimensions of attached rules.List of all the types of attached rules.Count of failed DQ rules attached to this asset.List of all the dimensions of failed rules.List of all the types of failed rules.Time (epoch) at which the last dq rule ran.Count of passed DQ rules attached to this asset.List of all the dimensions for which all the rules passed.List of all the types of rules for which all the rules passed.Tag for the result of the DQ rules.Count of DQ rules attached to this asset.Crontab of the DQ rule that will run at datasource.Time (epoch) at which the schedule synced to the source.Error code in the case of sync state being "error".Error message in the case of sync state being "error".Raw error message from the source.Latest sync status of the schedule to the source.Timezone of the DQ rule schedule that will run at datasourceType of schedule of the DQ rule that will run at datasource.DQ metadata captured for asset from external DQ tool(s).Name of the icon to use for this asset.Internal Popularity score for this asset.List of unique Monte Carlo alert names attached to this asset.List of Monte Carlo incident names attached to this asset.List of Monte Carlo incident priorities associated with this asset.List of unique Monte Carlo incident names attached to this asset.List of Monte Carlo incident severities associated with this asset.List of Monte Carlo incident states associated with this asset.List of Monte Carlo incident sub-types associated with this asset.List of Monte Carlo incident types associated with this asset.Tracks whether this asset is monitored by MC or notTime (epoch) at which this asset was last synced from Monte Carlo.List of Monte Carlo monitor names attached to this asset.List of unique Monte Carlo monitor names attached to this asset.Schedules of all associated Monte Carlo monitors.Statuses of all associated Monte Carlo monitors.Types of all associated Monte Carlo monitors.Count of policies inside the assetArray of policy ids governing this assetArray of asset ids that equivalent to this asset.Number of checks done via Soda.All associated Soda check statuses.Status of data quality from Soda.TBCTBCTBCReadme of this asset, as extracted from source.Name of the space that contains this asset.Unique name of the space that contains this asset.List of tags attached to this asset.Color (in hexadecimal RGB) to use to represent this asset.Name to use for this type of asset, as a subtype of the actual typeName.Glossary terms that are linked to this asset.Deprecated.Atlan tags assigned to the asset.Status of this asset's certification.Human-readable descriptive message used to provide further detail to certificateStatus.Time (epoch) at which the certification was last updated, in milliseconds.Name of the user who last updated the certification of this asset.Simple name of the connection through which this asset is accessible.Unique name of the connection through which this asset is accessible.Type of the connector through which this asset is accessible.Built-in connector type through which this asset is accessible.User or account that created the asset.Time (epoch) at which the asset was created, in milliseconds.Custom connector type through which this asset is accessible.getCustomMetadata(String setName, String attrName) Retrieve the value of the custom metadata attribute from this asset.Map of custom metadata attributes and values defined on the asset.Latest version of the data contract (in any status) for this asset.Latest certified version of the data contract for this asset.Unique name of this asset in dbt.Details on the handler used for deletion of the asset.getDepth()Depth of this asset within lineage.Description of this asset, for example as crawled from a source.Human-readable name of this asset used for display purposes (in user interface).Array of domain guids linked to this assetRules that are applied on this dataset.Rules where this dataset is referenced.getFiles()TBCWhether this asset has contract (true) or not (false).Whether this asset has lineage (true) or not (false).URL of an icon to use for this asset.Reference details about the asset(s) that are immediately downstream of this asset within lineage.Reference details about the asset(s) that are immediately upstream of this asset within lineage.Data products for which this asset is an input port.TBCWhether this asset is discoverable through the UI (true) or not (false).Whether this asset can be edited in the UI (true) or not (false).Unused.Indicates this asset is not fully-known, if true.Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.Name of the last run of the crawler that last synchronized this asset.Time (epoch) at which this asset was last crawled, in milliseconds.Name of the crawler that last synchronized this asset.Custom order for sorting purpose, managed by clientgetLinks()Links that are attached to this asset.TBCMonitors that observe this asset.Names of terms that have been linked to this asset.Deprecated.seeassignedTermsinsteadTBCgetName()Name of this asset.Array of policy ids non-compliant to this assetRetrieve the list of fields to be serialized with null values.Data products for which this asset is an output port.Array of product guids which have this asset as outputPortList of groups who own this asset.List of users who own this asset.Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset.Popularity score for this asset.Array of product guids linked to this assetUnique name for this asset.README that is linked to this asset.URL for sample data for this asset.TBCTBCThe unit of measure for sourceTotalCost.Time (epoch) at which this asset was created in the source system, in milliseconds.Name of the user who created this asset, in the source system.URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.Timestamp of most recent read operation.List of owners of this asset, in the source system.List of most expensive warehouses with extra insights.List of most expensive warehouse names.Total count of all read operations at source.List of the most expensive queries that accessed this asset.List of the most popular queries that accessed this asset.Total cost of read queries at source.List of usernames with extra insights for the most recent users who read this asset.List of usernames of the most recent users who read this asset.List of the slowest queries that accessed this asset.List of usernames with extra insights for the users who read this asset the most.List of usernames of the users who read this asset the most.Total number of unique users that read data from asset.Total cost of all operations at source.Time (epoch) at which this asset was last updated in the source system, in milliseconds.Name of the user who last updated this asset, in the source system.URL to the resource within the source application, used to create a button to view this asset in the source application.Users who have starred this asset.Number of users who have starred this asset.List of usernames with extra information of the users who have starred an asset.Status of the asset.Subtype of this asset.Name of the Atlan workspace in which this asset exists.User or account that last updated the asset.Time (epoch) at which the asset was last updated, in milliseconds.TBCTBCDescription of this asset, as provided by a user.List of groups who can view assets contained in a collection.List of users who can view assets contained in a collection.View score for this asset.inthashCode()lineage(AtlanClient client, String guid) Start a fluent lineage request that will return all active downstream assets.lineage(AtlanClient client, String guid, boolean includeArchived) Start a fluent lineage request that will return all downstream assets.static AssetDeletionResponsepurge(AtlanClient client, String guid) Hard-deletes (purges) an asset by its GUID.protected static AssetremoveAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder) Remove the announcement on an asset.protected static voidremoveAtlanTag(AtlanClient client, String typeName, String qualifiedName, String atlanTagName) Deprecated.protected static AssetremoveCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder) Remove the certificate on an asset.static voidremoveCustomMetadata(AtlanClient client, String guid, String cmName) Remove specific custom metadata from an asset.protected static AssetremoveDescription(AtlanClient client, Asset.AssetBuilder<?, ?> builder) Remove the system description from an asset.protected static AssetremoveOwners(AtlanClient client, Asset.AssetBuilder<?, ?> builder) Remove the owners from an asset.protected static AssetremoveTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) Deprecated.protected static AssetremoveUserDescription(AtlanClient client, Asset.AssetBuilder<?, ?> builder) Remove the user-provided description from an asset.static voidreplaceCustomMetadata(AtlanClient client, String guid, String cmName, CustomMetadataAttributes attributes) Replace specific custom metadata on the asset.protected static AssetreplaceTerms(AtlanClient client, Asset.AssetBuilder<?, ?> builder, List<IGlossaryTerm> terms) Replace the terms linked to an asset.requestLineage(AtlanClient client) Start a fluent lineage request that will return all active downstream assets.protected static booleanrestore(AtlanClient client, String typeName, String qualifiedName) Restore an archived (soft-deleted) asset to active.save(AtlanClient client) If an asset with the same qualifiedName exists, updates the existing asset.save(AtlanClient client, boolean replaceAtlanTags) Deprecated.saveMergingCM(AtlanClient client) If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided.saveMergingCM(AtlanClient client, boolean replaceAtlanTags) Deprecated.saveReplacingCM(AtlanClient client) If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided.saveReplacingCM(AtlanClient client, boolean replaceAtlanTags) Deprecated.toString()Reduce the asset to the minimum set of properties required to relate to it.Asset.AssetBuilder<?, ?> Reduce the asset to the minimum set of properties required to update it.protected static AssetupdateAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder, AtlanAnnouncementType type, String title, String message) Update the announcement on an asset.protected static AssetupdateAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder, String typeName, String qualifiedName, AtlanAnnouncementType type, String title, String message) Update the announcement on an asset.protected static AssetupdateCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder, CertificateStatus certificate, String message) Update the certificate on an asset.protected static AssetupdateCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder, String typeName, String qualifiedName, CertificateStatus certificate, String message) Update the certificate on an asset.static voidupdateCustomMetadataAttributes(AtlanClient client, String guid, String cmName, CustomMetadataAttributes attributes) Update only the provided custom metadata attributes on the asset.updateMergingCM(AtlanClient client) If no asset exists, fails with a NotFoundException.updateMergingCM(AtlanClient client, boolean replaceAtlanTags) Deprecated.updateReplacingCM(AtlanClient client) If no asset exists, fails with a NotFoundException.updateReplacingCM(AtlanClient client, boolean replaceAtlanTags) Deprecated.Methods inherited from class com.atlan.model.relations.Reference
builder, by, compareTo, getCompleteObject, getCustomAttributes, getDisplayText, getEntityStatus, getGuid, getLabels, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getSemantic, getTypeName, getUniqueAttributes, isComplete, isValidReference, isValidReferenceByGuid, isValidReferenceByQualifiedName, setCompleteObject, to, toBuilder, validateRelationship, validateRequiredMethods inherited from class com.atlan.model.core.AtlanObject
getRawJsonObject, setRawJsonObject, toJsonMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.atlan.model.search.AuditDetail
getRawJsonObject, setRawJsonObjectMethods inherited from interface com.atlan.model.assets.IAsset
getDisplayText, getEntityStatus, getGuid, getRelationshipAttributes, getRelationshipGuid, getRelationshipStatus, getRelationshipType, getTypeName, getUniqueAttributes, isComplete, isValidReferenceByGuid, isValidReferenceByQualifiedNameMethods inherited from interface com.atlan.model.assets.IReferenceable
getGuid, getTypeName
-
Constructor Details
-
Asset
-
-
Method Details
-
getConnectorName
Type of the connector through which this asset is accessible.- Specified by:
getConnectorNamein interfaceIAsset
-
getNullFields
Retrieve the list of fields to be serialized with null values. -
getQualifiedName
Unique name for this asset. This is typically a concatenation of the asset's name onto its parent's qualifiedName. This must be unique across all assets of the same type.- Specified by:
getQualifiedNamein interfaceIAsset- Specified by:
getQualifiedNamein interfaceIReferenceable
-
getCustomMetadata
Retrieve the value of the custom metadata attribute from this asset. Note: returns null in all cases where the custom metadata does not exist, is not available on this asset, or simply is not assigned any value on this asset.- Parameters:
setName- the name of the custom metadata set from which to retrieve the attribute's valueattrName- the name of the custom metadata attribute for which to retrieve the value- Returns:
- the value of that custom metadata attribute on this asset, or null if there is no value
-
trimToRequired
Reduce the asset to the minimum set of properties required to update it.- Returns:
- a builder containing the minimal set of properties required to update this asset
- Throws:
InvalidRequestException- if any of the minimal set of required properties are not found in the initial object
-
trimToReference
Reduce the asset to the minimum set of properties required to relate to it.- Returns:
- an asset containing the minimal set of properties required to relate to this asset
- Throws:
InvalidRequestException- if any of the minimal set of required properties are not found in the initial object
-
save
If an asset with the same qualifiedName exists, updates the existing asset. Otherwise, creates the asset. No Atlan tags or custom metadata will be changed if updating an existing asset, irrespective of what is included in the asset itself when the method is called.- Parameters:
client- connectivity to the Atlan tenant on which to save the asset- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
save
@Deprecated public AssetMutationResponse save(AtlanClient client, boolean replaceAtlanTags) throws AtlanException Deprecated.If no asset exists, has the same behavior as thesave(AtlanClient)method. If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always be entirely ignored using this method.- Parameters:
client- connectivity to the Atlan tenant on which to save this assetreplaceAtlanTags- whether to replace Atlan tags during an update (true) or not (false)- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
saveMergingCM
If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided. Will merge any provided custom metadata with any custom metadata that already exists on the asset.- Parameters:
client- connectivity to the Atlan tenant where this asset should be saved- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
saveMergingCM
@Deprecated public AssetMutationResponse saveMergingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException Deprecated.If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided. If an asset does exist, optionally overwrites any Atlan tags. Will merge any provided custom metadata with any custom metadata that already exists on the asset.- Parameters:
client- connectivity to the Atlan tenant where this asset should be savedreplaceAtlanTags- whether to replace AtlanTags during an update (true) or not (false)- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
saveReplacingCM
If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided. Will overwrite all custom metadata on any existing asset with only the custom metadata provided (wiping out any other custom metadata on an existing asset that is not provided in the request).- Parameters:
client- connectivity to the Atlan tenant where this asset should be saved- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
saveReplacingCM
@Deprecated public AssetMutationResponse saveReplacingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException Deprecated.If no asset exists, has the same behavior as thesave(AtlanClient)method, while also setting any custom metadata provided. If an asset does exist, optionally overwrites any Atlan tags. Will overwrite all custom metadata on any existing asset with only the custom metadata provided (wiping out any other custom metadata on an existing asset that is not provided in the request).- Parameters:
client- connectivity to the Atlan tenant where this asset should be savedreplaceAtlanTags- whether to replace Atlan tags during an update (true) or not (false)- Returns:
- details of the created or updated asset
- Throws:
AtlanException- on any error during the API invocation
-
updateMergingCM
If no asset exists, fails with a NotFoundException. Will merge any provided custom metadata with any custom metadata that already exists on the asset.- Parameters:
client- connectivity to the Atlan tenant where this asset should be saved- Returns:
- details of the updated asset
- Throws:
AtlanException- on any error during the API invocationNotFoundException- if the asset does not exist (will not create it)
-
updateMergingCM
@Deprecated public AssetMutationResponse updateMergingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException Deprecated.If no asset exists, fails with a NotFoundException. Will merge any provided custom metadata with any custom metadata that already exists on the asset. If an asset does exist, optionally overwrites any Atlan tags.- Parameters:
client- connectivity to the Atlan tenant where this asset should be savedreplaceAtlanTags- whether to replace AtlanTags during an update (true) or not (false)- Returns:
- details of the updated asset
- Throws:
AtlanException- on any error during the API invocationNotFoundException- if the asset does not exist (will not create it)
-
updateReplacingCM
If no asset exists, fails with a NotFoundException. Will overwrite all custom metadata on any existing asset with only the custom metadata provided (wiping out any other custom metadata on an existing asset that is not provided in the request).- Parameters:
client- connectivity to the Atlan tenant where this asset should be saved- Returns:
- details of the updated asset
- Throws:
AtlanException- on any error during the API invocationNotFoundException- if the asset does not exist (will not create it)
-
updateReplacingCM
@Deprecated public AssetMutationResponse updateReplacingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException Deprecated.If no asset exists, fails with a NotFoundException. Will overwrite all custom metadata on any existing asset with only the custom metadata provided (wiping out any other custom metadata on an existing asset that is not provided in the request). If an asset does exist, optionally overwrites any Atlan tags.- Parameters:
client- connectivity to the Atlan tenant where this asset should be savedreplaceAtlanTags- whether to replace Atlan tags during an update (true) or not (false)- Returns:
- details of the updated asset
- Throws:
AtlanException- on any error during the API invocationNotFoundException- if the asset does not exist (will not create it)
-
requestLineage
Start a fluent lineage request that will return all active downstream assets. Additional conditions can be chained onto the returned builder before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) assets will be included. (To change the default direction of downstream, chain a .direction() call.)- Parameters:
client- connectivity to Atlan tenant- Returns:
- a fluent lineage request that includes all active downstream assets
-
addApiTokenAsAdmin
protected static AssetMutationResponse addApiTokenAsAdmin(AtlanClient client, String assetGuid, String impersonationToken) throws AtlanException Add the API token configured for the default client as an admin to this object.- Parameters:
client- connectivity to Atlan tenantassetGuid- unique identifier (GUID) of the asset to which we should add this API token as an adminimpersonationToken- a bearer token for an actual user who is already an admin for the object, NOT an API token- Throws:
AtlanException- on any error during API invocation
-
get
public static Asset get(AtlanClient client, String guid, boolean includeAllRelationships) throws AtlanException Retrieves an asset by its GUID, optionally complete with all of its relationships. The type of the asset will only be determined at runtime.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetguid- of the asset to retrieveincludeAllRelationships- if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full asset, optionally complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the asset does not exist
-
get
public static Asset get(AtlanClient client, String typeName, String qualifiedName, boolean includeAllRelationships) throws AtlanException Retrieves an asset by its qualifiedName, optionally complete with all of its relationships. The type of the asset will only be determined at runtime.- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assettypeName- the type of the asset to retrievequalifiedName- the unique name of the asset to retrieveincludeAllRelationships- if true, all the asset's relationships will also be retrieved; if false, no relationships will be retrieved- Returns:
- the requested full asset, optionally complete with all of its relationships
- Throws:
AtlanException- on any error during the API invocation, such as theNotFoundExceptionif the asset does not exist
-
delete
Soft-deletes an asset by its GUID. This operation can be reversed by updating the asset and changing itsstatustoACTIVE.- Parameters:
client- connectivity to the Atlan tenant from which to delete the assetguid- of the asset to soft-delete- Returns:
- details of the soft-deleted asset
- Throws:
AtlanException- on any error during the API invocation
-
purge
Hard-deletes (purges) an asset by its GUID. This operation is irreversible.- Parameters:
client- connectivity to the Atlan tenant from which to delete the assetguid- of the asset to hard-delete- Returns:
- details of the hard-deleted asset
- Throws:
AtlanException- on any error during the API invocation
-
lineage
Start a fluent lineage request that will return all active downstream assets. Additional conditions can be chained onto the returned builder before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) assets will be included. (To change the default direction of downstream, chain a .direction() call.)- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the assetsguid- unique identifier (GUID) for the starting point of lineage- Returns:
- a fluent lineage request that includes all active downstream assets
-
lineage
public static FluentLineage.FluentLineageBuilder lineage(AtlanClient client, String guid, boolean includeArchived) Start a fluent lineage request that will return all downstream assets. Additional conditions can be chained onto the returned builder before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. (To change the default direction of downstream, chain a .direction() call.)- Parameters:
client- connectivity to the Atlan tenant from which to retrieve the lineageguid- unique identifier (GUID) for the starting point of lineageincludeArchived- when true, archived (soft-deleted) assets in lineage will be included- Returns:
- a fluent search that includes all downstream assets
-
updateCustomMetadataAttributes
public static void updateCustomMetadataAttributes(AtlanClient client, String guid, String cmName, CustomMetadataAttributes attributes) throws AtlanException Update only the provided custom metadata attributes on the asset. This will leave all other custom metadata attributes, even within the same named custom metadata, unchanged.- Parameters:
client- connectivity to the Atlan tenant on which to update the asset's custom metadata attributesguid- unique identifier of the assetcmName- human-readable name of the custom metadata to updateattributes- the values of the custom metadata attributes to change- Throws:
AtlanException- on any API problems, or if the custom metadata is not defined in Atlan
-
replaceCustomMetadata
public static void replaceCustomMetadata(AtlanClient client, String guid, String cmName, CustomMetadataAttributes attributes) throws AtlanException Replace specific custom metadata on the asset. This will replace everything within the named custom metadata, but will not change any of the other named custom metadata on the asset.- Parameters:
client- connectivity to the Atlan tenant on which to replace the asset's custom metadataguid- unique identifier of the assetcmName- human-readable name of the custom metadata to replaceattributes- the values of the attributes to replace for the custom metadata- Throws:
AtlanException- on any API problems, or if the custom metadata is not defined in Atlan
-
removeCustomMetadata
public static void removeCustomMetadata(AtlanClient client, String guid, String cmName) throws AtlanException Remove specific custom metadata from an asset.- Parameters:
client- connectivity to the Atlan tenant from which to remove the asset's custom metadataguid- unique identifier of the assetcmName- human-readable name of the custom metadata to remove- Throws:
AtlanException- on any API problems, or if the custom metadata is not defined in Atlan
-
appendAtlanTags
@Deprecated protected static Asset appendAtlanTags(AtlanClient client, String typeName, String qualifiedName, List<String> atlanTagNames) throws AtlanException Deprecated.Add Atlan tags to an asset, without replacing existing Atlan tags linked to the asset. Note: this operation must make two API calls — one to retrieve the asset'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 assettypeName- type of the assetqualifiedName- of the assetatlanTagNames- human-readable names of the Atlan tags to append- Returns:
- the asset that was updated
- Throws:
AtlanException- on any API problems
-
appendAtlanTags
@Deprecated protected static Asset appendAtlanTags(AtlanClient client, String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException Add Atlan tags to an asset, without replacing existing Atlan tags linked to the asset. Note: this operation must make two API calls — one to retrieve the asset's existing Atlan tags, and a second to append the new Atlan tags.- Parameters:
client- connectivity to the Atlan tenant on which to add the Atlan tags to the assettypeName- type of the assetqualifiedName- of the assetatlanTagNames- human-readable names of the Atlan tags to addpropagate- 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 asset that was updated
- Throws:
AtlanException- on any API problems
-
removeAtlanTag
@Deprecated protected static void removeAtlanTag(AtlanClient client, String typeName, String qualifiedName, String atlanTagName) throws AtlanException Deprecated.Remove an Atlan tag from an asset.- Parameters:
client- connectivity to the Atlan tenant on which to remove the Atlan tag from the assettypeName- type of the assetqualifiedName- of the assetatlanTagName- human-readable name of the Atlan tags to remove- Throws:
AtlanException- on any API problems, or if any of the Atlan tag does not exist on the asset
-
updateCertificate
protected static Asset updateCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder, CertificateStatus certificate, String message) throws AtlanExceptionUpdate the certificate on an asset.- Parameters:
client- connectivity to the Atlan tenant on which to update the asset's certificatebuilder- the builder to use for updating the certificatecertificate- certificate to setmessage- (optional) message 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
-
removeCertificate
protected static Asset removeCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder) throws AtlanExceptionRemove the certificate on an asset.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's certificatebuilder- the builder to use for removing the certificate- Returns:
- the result of the removal, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateAnnouncement
protected static Asset updateAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder, AtlanAnnouncementType type, String title, String message) throws AtlanExceptionUpdate the announcement on an asset.- Parameters:
client- connectivity to the Atlan tenant on which to update the asset's announcementbuilder- the builder to use for updating the announcementtype- type of announcement to settitle- (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
protected static Asset removeAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder) throws AtlanExceptionRemove the announcement on an asset.- Parameters:
client- connectivity to the Atlan tenant from which to remove the asset's announcementbuilder- the builder to use for removing the announcement- Returns:
- the result of the removal, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeDescription
protected static Asset removeDescription(AtlanClient client, Asset.AssetBuilder<?, ?> builder) throws AtlanExceptionRemove the system description from an asset.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionbuilder- the builder to use for removing the description- Returns:
- the result of the removal, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeUserDescription
protected static Asset removeUserDescription(AtlanClient client, Asset.AssetBuilder<?, ?> builder) throws AtlanExceptionRemove the user-provided description from an asset.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's descriptionbuilder- the builder to use for removing the description- Returns:
- the result of the removal, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
removeOwners
protected static Asset removeOwners(AtlanClient client, Asset.AssetBuilder<?, ?> builder) throws AtlanExceptionRemove the owners from an asset.- Parameters:
client- connectivity to the Atlan tenant on which to remove the asset's ownersbuilder- the builder to use for removing the owners- Returns:
- the result of the removal, or null if the removal failed
- Throws:
AtlanException- on any API problems
-
updateCertificate
protected static Asset updateCertificate(AtlanClient client, Asset.AssetBuilder<?, ?> builder, String typeName, String qualifiedName, CertificateStatus certificate, String message) throws AtlanExceptionUpdate the certificate on an asset.- Parameters:
client- connectivity to the Atlan tenant on which to update the asset's certificatebuilder- the builder to use for updating the certificatetypeName- type of the assetqualifiedName- for the assetcertificate- certificate to setmessage- (optional) message 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
-
updateAnnouncement
protected static Asset updateAnnouncement(AtlanClient client, Asset.AssetBuilder<?, ?> builder, String typeName, String qualifiedName, AtlanAnnouncementType type, String title, String message) throws AtlanExceptionUpdate the announcement on an asset.- Parameters:
client- connectivity to the Atlan tenant on which to update the asset's announcementbuilder- the builder to use for updating the announcementtypeName- type of the assetqualifiedName- for the assettype- type of announcement to settitle- (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
-
restore
protected static boolean restore(AtlanClient client, String typeName, String qualifiedName) throws AtlanException Restore an archived (soft-deleted) asset to active.- Parameters:
client- connectivity to the Atlan tenant on which to restore the assettypeName- type of the asset to restorequalifiedName- of the asset to restore- Returns:
- true if the asset is now restored, or false if not
- Throws:
AtlanException- on any API problems
-
replaceTerms
protected static Asset replaceTerms(AtlanClient client, Asset.AssetBuilder<?, ?> builder, List<IGlossaryTerm> terms) throws AtlanExceptionReplace the terms linked to an asset.- Parameters:
client- connectivity to the Atlan tenant on which to replace the asset's termsbuilder- the builder to use for updating the termsterms- the list of terms to replace on the asset, or null to remove all terms from an asset- Returns:
- the asset that was updated (note that it will NOT contain details of the replaced terms)
- Throws:
AtlanException- on any API problems
-
appendTerms
@Deprecated protected static Asset appendTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Link additional terms to an asset, without replacing existing terms linked to the asset. Note: this operation must make two API calls — one to retrieve the asset'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 assettypeName- type of the assetqualifiedName- for the assetterms- the list of terms to append to the asset- Returns:
- the asset that was updated (note that it will NOT contain details of the appended terms)
- Throws:
AtlanException- on any API problems
-
removeTerms
@Deprecated protected static Asset removeTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException Deprecated.Remove terms from an asset, without replacing all existing terms linked to the asset. Note: this operation must make two API calls — one to retrieve the asset's existing terms, and a second to remove the provided terms.- Parameters:
client- connectivity to the Atlan tenant on which to remove terms from the assettypeName- type of the assetqualifiedName- for the assetterms- the list of terms to remove from the asset (note: these must be references by GUID in order to efficiently remove any existing terms)- Returns:
- the asset that was updated (note that it will NOT contain details of the resulting terms)
- Throws:
AtlanException- on any API problemsInvalidRequestException- if any of the passed terms are not valid references by GUID to a term
-
getAdminGroups
List of groups who administer this asset. (This is only used for certain asset types.)- Specified by:
getAdminGroupsin interfaceIAsset
-
getAdminRoles
List of roles who administer this asset. (This is only used for Connection assets.)- Specified by:
getAdminRolesin interfaceIAsset
-
getAdminUsers
List of users who administer this asset. (This is only used for certain asset types.)- Specified by:
getAdminUsersin interfaceIAsset
-
getAnnouncementMessage
Detailed message to include in the announcement on this asset.- Specified by:
getAnnouncementMessagein interfaceIAsset
-
getAnnouncementTitle
Brief title for the announcement on this asset. Required when announcementType is specified.- Specified by:
getAnnouncementTitlein interfaceIAsset
-
getAnnouncementType
Type of announcement on this asset.- Specified by:
getAnnouncementTypein interfaceIAsset
-
getAnnouncementUpdatedAt
Time (epoch) at which the announcement was last updated, in milliseconds.- Specified by:
getAnnouncementUpdatedAtin interfaceIAsset
-
getAnnouncementUpdatedBy
Name of the user who last updated the announcement.- Specified by:
getAnnouncementUpdatedByin interfaceIAsset
-
getAnomaloChecks
Checks that run on this asset.- Specified by:
getAnomaloChecksin interfaceIAsset
-
getApplication
Application owning the Asset.- Specified by:
getApplicationin interfaceIAsset
-
getApplicationField
ApplicationField owning the Asset.- Specified by:
getApplicationFieldin interfaceIAsset
-
getApplicationFieldQualifiedName
Qualified name of the ApplicationField that contains this asset.- Specified by:
getApplicationFieldQualifiedNamein interfaceIAsset
-
getApplicationQualifiedName
Qualified name of the Application that contains this asset.- Specified by:
getApplicationQualifiedNamein interfaceIAsset
-
getAssetAnomaloAppliedCheckTypes
All associated Anomalo check types.- Specified by:
getAssetAnomaloAppliedCheckTypesin interfaceIAsset
-
getAssetAnomaloCheckCount
Total number of checks present in Anomalo for this asset.- Specified by:
getAssetAnomaloCheckCountin interfaceIAsset
-
getAssetAnomaloCheckStatuses
Stringified JSON object containing status of all Anomalo checks associated to this asset.- Specified by:
getAssetAnomaloCheckStatusesin interfaceIAsset
-
getAssetAnomaloDQStatus
Status of data quality from Anomalo.- Specified by:
getAssetAnomaloDQStatusin interfaceIAsset
-
getAssetAnomaloFailedCheckCount
Total number of checks failed in Anomalo for this asset.- Specified by:
getAssetAnomaloFailedCheckCountin interfaceIAsset
-
getAssetAnomaloFailedCheckTypes
All associated Anomalo failed check types.- Specified by:
getAssetAnomaloFailedCheckTypesin interfaceIAsset
-
getAssetAnomaloLastCheckRunAt
Time (epoch) at which the last check was run via Anomalo.- Specified by:
getAssetAnomaloLastCheckRunAtin interfaceIAsset
-
getAssetAnomaloSourceUrl
URL of the source in Anomalo.- Specified by:
getAssetAnomaloSourceUrlin interfaceIAsset
-
getAssetCoverImage
Cover image to use for this asset in the UI (applicable to only a few asset types).- Specified by:
getAssetCoverImagein interfaceIAsset
-
getAssetDQFreshnessExpectation
Expectation of data freshness from Source.- Specified by:
getAssetDQFreshnessExpectationin interfaceIAsset
-
getAssetDQFreshnessValue
Value of data freshness from Source.- Specified by:
getAssetDQFreshnessValuein interfaceIAsset
-
getAssetDQResult
Overall result of all the dq rules. If any one rule failed, then fail else pass.- Specified by:
getAssetDQResultin interfaceIAsset
-
getAssetDQRowScopeFilterColumnQualifiedName
Qualified name of the column used for row scope filtering in DQ rules for this asset.- Specified by:
getAssetDQRowScopeFilterColumnQualifiedNamein interfaceIAsset
-
getAssetDQRuleAttachedDimensions
List of all the dimensions of attached rules.- Specified by:
getAssetDQRuleAttachedDimensionsin interfaceIAsset
-
getAssetDQRuleAttachedRuleTypes
List of all the types of attached rules.- Specified by:
getAssetDQRuleAttachedRuleTypesin interfaceIAsset
-
getAssetDQRuleFailedCount
Count of failed DQ rules attached to this asset.- Specified by:
getAssetDQRuleFailedCountin interfaceIAsset
-
getAssetDQRuleFailedDimensions
List of all the dimensions of failed rules.- Specified by:
getAssetDQRuleFailedDimensionsin interfaceIAsset
-
getAssetDQRuleFailedRuleTypes
List of all the types of failed rules.- Specified by:
getAssetDQRuleFailedRuleTypesin interfaceIAsset
-
getAssetDQRuleLastRunAt
Time (epoch) at which the last dq rule ran.- Specified by:
getAssetDQRuleLastRunAtin interfaceIAsset
-
getAssetDQRulePassedCount
Count of passed DQ rules attached to this asset.- Specified by:
getAssetDQRulePassedCountin interfaceIAsset
-
getAssetDQRulePassedDimensions
List of all the dimensions for which all the rules passed.- Specified by:
getAssetDQRulePassedDimensionsin interfaceIAsset
-
getAssetDQRulePassedRuleTypes
List of all the types of rules for which all the rules passed.- Specified by:
getAssetDQRulePassedRuleTypesin interfaceIAsset
-
getAssetDQRuleResultTags
Tag for the result of the DQ rules. Eg, rule_pass:completeness:null_count.- Specified by:
getAssetDQRuleResultTagsin interfaceIAsset
-
getAssetDQRuleTotalCount
Count of DQ rules attached to this asset.- Specified by:
getAssetDQRuleTotalCountin interfaceIAsset
-
getAssetDQScheduleCrontab
Crontab of the DQ rule that will run at datasource.- Specified by:
getAssetDQScheduleCrontabin interfaceIAsset
-
getAssetDQScheduleSourceSyncErrorCode
Error code in the case of sync state being "error".- Specified by:
getAssetDQScheduleSourceSyncErrorCodein interfaceIAsset
-
getAssetDQScheduleSourceSyncErrorMessage
Error message in the case of sync state being "error".- Specified by:
getAssetDQScheduleSourceSyncErrorMessagein interfaceIAsset
-
getAssetDQScheduleSourceSyncRawError
Raw error message from the source.- Specified by:
getAssetDQScheduleSourceSyncRawErrorin interfaceIAsset
-
getAssetDQScheduleSourceSyncStatus
Latest sync status of the schedule to the source.- Specified by:
getAssetDQScheduleSourceSyncStatusin interfaceIAsset
-
getAssetDQScheduleSourceSyncedAt
Time (epoch) at which the schedule synced to the source.- Specified by:
getAssetDQScheduleSourceSyncedAtin interfaceIAsset
-
getAssetDQScheduleTimeZone
Timezone of the DQ rule schedule that will run at datasource- Specified by:
getAssetDQScheduleTimeZonein interfaceIAsset
-
getAssetDQScheduleType
Type of schedule of the DQ rule that will run at datasource.- Specified by:
getAssetDQScheduleTypein interfaceIAsset
-
getAssetDbtAccountName
Name of the account in which this asset exists in dbt.- Specified by:
getAssetDbtAccountNamein interfaceIAsset
-
getAssetDbtAlias
Alias of this asset in dbt.- Specified by:
getAssetDbtAliasin interfaceIAsset
-
getAssetDbtEnvironmentDbtVersion
Version of the environment in which this asset is materialized in dbt.- Specified by:
getAssetDbtEnvironmentDbtVersionin interfaceIAsset
-
getAssetDbtEnvironmentName
Name of the environment in which this asset is materialized in dbt.- Specified by:
getAssetDbtEnvironmentNamein interfaceIAsset
-
getAssetDbtJobLastRun
Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.- Specified by:
getAssetDbtJobLastRunin interfaceIAsset
-
getAssetDbtJobLastRunArtifactS3Path
Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunArtifactS3Pathin interfaceIAsset
-
getAssetDbtJobLastRunArtifactsSaved
Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).- Specified by:
getAssetDbtJobLastRunArtifactsSavedin interfaceIAsset
-
getAssetDbtJobLastRunCreatedAt
Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.- Specified by:
getAssetDbtJobLastRunCreatedAtin interfaceIAsset
-
getAssetDbtJobLastRunDequedAt
Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.- Specified by:
getAssetDbtJobLastRunDequedAtin interfaceIAsset
-
getAssetDbtJobLastRunExecutedByThreadId
Thread ID of the user who executed the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunExecutedByThreadIdin interfaceIAsset
-
getAssetDbtJobLastRunGitBranch
Branch in git from which the last run of the job that materialized this asset in dbt ran.- Specified by:
getAssetDbtJobLastRunGitBranchin interfaceIAsset
-
getAssetDbtJobLastRunGitSha
SHA hash in git for the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunGitShain interfaceIAsset
-
getAssetDbtJobLastRunHasDocsGenerated
Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).- Specified by:
getAssetDbtJobLastRunHasDocsGeneratedin interfaceIAsset
-
getAssetDbtJobLastRunHasSourcesGenerated
Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).- Specified by:
getAssetDbtJobLastRunHasSourcesGeneratedin interfaceIAsset
-
getAssetDbtJobLastRunNotificationsSent
Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).- Specified by:
getAssetDbtJobLastRunNotificationsSentin interfaceIAsset
-
getAssetDbtJobLastRunOwnerThreadId
Thread ID of the owner of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunOwnerThreadIdin interfaceIAsset
-
getAssetDbtJobLastRunQueuedDuration
Total duration the job that materialized this asset in dbt spent being queued.- Specified by:
getAssetDbtJobLastRunQueuedDurationin interfaceIAsset
-
getAssetDbtJobLastRunQueuedDurationHumanized
Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.- Specified by:
getAssetDbtJobLastRunQueuedDurationHumanizedin interfaceIAsset
-
getAssetDbtJobLastRunRunDuration
Run duration of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunRunDurationin interfaceIAsset
-
getAssetDbtJobLastRunRunDurationHumanized
Human-readable run duration of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunRunDurationHumanizedin interfaceIAsset
-
getAssetDbtJobLastRunStartedAt
Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.- Specified by:
getAssetDbtJobLastRunStartedAtin interfaceIAsset
-
getAssetDbtJobLastRunStatusMessage
Status message of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunStatusMessagein interfaceIAsset
-
getAssetDbtJobLastRunTotalDuration
Total duration of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunTotalDurationin interfaceIAsset
-
getAssetDbtJobLastRunTotalDurationHumanized
Human-readable total duration of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunTotalDurationHumanizedin interfaceIAsset
-
getAssetDbtJobLastRunUpdatedAt
Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.- Specified by:
getAssetDbtJobLastRunUpdatedAtin interfaceIAsset
-
getAssetDbtJobLastRunUrl
URL of the last run of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobLastRunUrlin interfaceIAsset
-
getAssetDbtJobName
Name of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobNamein interfaceIAsset
-
getAssetDbtJobNextRun
Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.- Specified by:
getAssetDbtJobNextRunin interfaceIAsset
-
getAssetDbtJobNextRunHumanized
Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.- Specified by:
getAssetDbtJobNextRunHumanizedin interfaceIAsset
-
getAssetDbtJobSchedule
Schedule of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobSchedulein interfaceIAsset
-
getAssetDbtJobScheduleCronHumanized
Human-readable cron schedule of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobScheduleCronHumanizedin interfaceIAsset
-
getAssetDbtJobStatus
Status of the job that materialized this asset in dbt.- Specified by:
getAssetDbtJobStatusin interfaceIAsset
-
getAssetDbtMeta
Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.- Specified by:
getAssetDbtMetain interfaceIAsset
-
getAssetDbtPackageName
Name of the package in which this asset exists in dbt.- Specified by:
getAssetDbtPackageNamein interfaceIAsset
-
getAssetDbtProjectName
Name of the project in which this asset exists in dbt.- Specified by:
getAssetDbtProjectNamein interfaceIAsset
-
getAssetDbtSemanticLayerProxyUrl
URL of the semantic layer proxy for this asset in dbt.- Specified by:
getAssetDbtSemanticLayerProxyUrlin interfaceIAsset
-
getAssetDbtSourceFreshnessCriteria
Freshness criteria for the source of this asset in dbt.- Specified by:
getAssetDbtSourceFreshnessCriteriain interfaceIAsset
-
getAssetDbtTags
List of tags attached to this asset in dbt.- Specified by:
getAssetDbtTagsin interfaceIAsset
-
getAssetDbtTestStatus
All associated dbt test statuses.- Specified by:
getAssetDbtTestStatusin interfaceIAsset
-
getAssetDbtUniqueId
Unique identifier of this asset in dbt.- Specified by:
getAssetDbtUniqueIdin interfaceIAsset
-
getAssetDbtWorkflowLastUpdated
Name of the DBT workflow in Atlan that last updated the asset.- Specified by:
getAssetDbtWorkflowLastUpdatedin interfaceIAsset
-
getAssetExternalDQMetadataDetails
DQ metadata captured for asset from external DQ tool(s).- Specified by:
getAssetExternalDQMetadataDetailsin interfaceIAsset
-
getAssetIcon
Name of the icon to use for this asset. (Only applies to glossaries, currently.)- Specified by:
getAssetIconin interfaceIAsset
-
getAssetInternalPopularityScore
Internal Popularity score for this asset.- Specified by:
getAssetInternalPopularityScorein interfaceIAsset
-
getAssetMcAlertQualifiedNames
List of unique Monte Carlo alert names attached to this asset.- Specified by:
getAssetMcAlertQualifiedNamesin interfaceIAsset
-
getAssetMcIncidentNames
List of Monte Carlo incident names attached to this asset.- Specified by:
getAssetMcIncidentNamesin interfaceIAsset
-
getAssetMcIncidentPriorities
List of Monte Carlo incident priorities associated with this asset.- Specified by:
getAssetMcIncidentPrioritiesin interfaceIAsset
-
getAssetMcIncidentQualifiedNames
List of unique Monte Carlo incident names attached to this asset.- Specified by:
getAssetMcIncidentQualifiedNamesin interfaceIAsset
-
getAssetMcIncidentSeverities
List of Monte Carlo incident severities associated with this asset.- Specified by:
getAssetMcIncidentSeveritiesin interfaceIAsset
-
getAssetMcIncidentStates
List of Monte Carlo incident states associated with this asset.- Specified by:
getAssetMcIncidentStatesin interfaceIAsset
-
getAssetMcIncidentSubTypes
List of Monte Carlo incident sub-types associated with this asset.- Specified by:
getAssetMcIncidentSubTypesin interfaceIAsset
-
getAssetMcIncidentTypes
List of Monte Carlo incident types associated with this asset.- Specified by:
getAssetMcIncidentTypesin interfaceIAsset
-
getAssetMcIsMonitored
Tracks whether this asset is monitored by MC or not- Specified by:
getAssetMcIsMonitoredin interfaceIAsset
-
getAssetMcLastSyncRunAt
Time (epoch) at which this asset was last synced from Monte Carlo.- Specified by:
getAssetMcLastSyncRunAtin interfaceIAsset
-
getAssetMcMonitorNames
List of Monte Carlo monitor names attached to this asset.- Specified by:
getAssetMcMonitorNamesin interfaceIAsset
-
getAssetMcMonitorQualifiedNames
List of unique Monte Carlo monitor names attached to this asset.- Specified by:
getAssetMcMonitorQualifiedNamesin interfaceIAsset
-
getAssetMcMonitorScheduleTypes
Schedules of all associated Monte Carlo monitors.- Specified by:
getAssetMcMonitorScheduleTypesin interfaceIAsset
-
getAssetMcMonitorStatuses
Statuses of all associated Monte Carlo monitors.- Specified by:
getAssetMcMonitorStatusesin interfaceIAsset
-
getAssetMcMonitorTypes
Types of all associated Monte Carlo monitors.- Specified by:
getAssetMcMonitorTypesin interfaceIAsset
-
getAssetPoliciesCount
Count of policies inside the asset- Specified by:
getAssetPoliciesCountin interfaceIAsset
-
getAssetPolicyGUIDs
Array of policy ids governing this asset- Specified by:
getAssetPolicyGUIDsin interfaceIAsset
-
getAssetRedirectGUIDs
Array of asset ids that equivalent to this asset.- Specified by:
getAssetRedirectGUIDsin interfaceIAsset
-
getAssetSodaCheckCount
Number of checks done via Soda.- Specified by:
getAssetSodaCheckCountin interfaceIAsset
-
getAssetSodaCheckStatuses
All associated Soda check statuses.- Specified by:
getAssetSodaCheckStatusesin interfaceIAsset
-
getAssetSodaDQStatus
Status of data quality from Soda.- Specified by:
getAssetSodaDQStatusin interfaceIAsset
-
getAssetSodaLastScanAt
TBC- Specified by:
getAssetSodaLastScanAtin interfaceIAsset
-
getAssetSodaLastSyncRunAt
TBC- Specified by:
getAssetSodaLastSyncRunAtin interfaceIAsset
-
getAssetSodaSourceURL
TBC- Specified by:
getAssetSodaSourceURLin interfaceIAsset
-
getAssetSourceReadme
Readme of this asset, as extracted from source. If present, this will be used for the readme in user interface.- Specified by:
getAssetSourceReadmein interfaceIAsset
-
getAssetSpaceName
Name of the space that contains this asset.- Specified by:
getAssetSpaceNamein interfaceIAsset
-
getAssetSpaceQualifiedName
Unique name of the space that contains this asset.- Specified by:
getAssetSpaceQualifiedNamein interfaceIAsset
-
getAssetTags
List of tags attached to this asset.- Specified by:
getAssetTagsin interfaceIAsset
-
getAssetThemeHex
Color (in hexadecimal RGB) to use to represent this asset.- Specified by:
getAssetThemeHexin interfaceIAsset
-
getAssetUserDefinedType
Name to use for this type of asset, as a subtype of the actual typeName.- Specified by:
getAssetUserDefinedTypein interfaceIAsset
-
getAssignedTerms
Glossary terms that are linked to this asset.- Specified by:
getAssignedTermsin interfaceIAsset
-
getCertificateStatus
Status of this asset's certification.- Specified by:
getCertificateStatusin interfaceIAsset
-
getCertificateStatusMessage
Human-readable descriptive message used to provide further detail to certificateStatus.- Specified by:
getCertificateStatusMessagein interfaceIAsset
-
getCertificateUpdatedAt
Time (epoch) at which the certification was last updated, in milliseconds.- Specified by:
getCertificateUpdatedAtin interfaceIAsset
-
getCertificateUpdatedBy
Name of the user who last updated the certification of this asset.- Specified by:
getCertificateUpdatedByin interfaceIAsset
-
getConnectionName
Simple name of the connection through which this asset is accessible.- Specified by:
getConnectionNamein interfaceIAsset
-
getConnectionQualifiedName
Unique name of the connection through which this asset is accessible.- Specified by:
getConnectionQualifiedNamein interfaceIAsset
-
getDataContractLatest
Latest version of the data contract (in any status) for this asset.- Specified by:
getDataContractLatestin interfaceIAsset
-
getDataContractLatestCertified
Latest certified version of the data contract for this asset.- Specified by:
getDataContractLatestCertifiedin interfaceIAsset
-
getDbtQualifiedName
Unique name of this asset in dbt.- Specified by:
getDbtQualifiedNamein interfaceIAsset
-
getDescription
Description of this asset, for example as crawled from a source. Fallback for display purposes, if userDescription is empty.- Specified by:
getDescriptionin interfaceIAsset
-
getDisplayName
Human-readable name of this asset used for display purposes (in user interface).- Specified by:
getDisplayNamein interfaceIAsset
-
getDomainGUIDs
Array of domain guids linked to this asset- Specified by:
getDomainGUIDsin interfaceIAsset
-
getDqBaseDatasetRules
Rules that are applied on this dataset.- Specified by:
getDqBaseDatasetRulesin interfaceIAsset
-
getDqReferenceDatasetRules
Rules where this dataset is referenced.- Specified by:
getDqReferenceDatasetRulesin interfaceIAsset
-
getFiles
TBC -
getHasContract
Whether this asset has contract (true) or not (false).- Specified by:
getHasContractin interfaceIAsset
-
getHasLineage
Whether this asset has lineage (true) or not (false).- Specified by:
getHasLineagein interfaceIAsset
-
getInputPortDataProducts
Data products for which this asset is an input port.- Specified by:
getInputPortDataProductsin interfaceIAsset
-
getIsAIGenerated
TBC- Specified by:
getIsAIGeneratedin interfaceIAsset
-
getIsDiscoverable
Whether this asset is discoverable through the UI (true) or not (false).- Specified by:
getIsDiscoverablein interfaceIAsset
-
getIsEditable
Whether this asset can be edited in the UI (true) or not (false).- Specified by:
getIsEditablein interfaceIAsset
-
getIsPartial
Indicates this asset is not fully-known, if true.- Specified by:
getIsPartialin interfaceIAsset
-
getLastRowChangedAt
Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.- Specified by:
getLastRowChangedAtin interfaceIAsset
-
getLastSyncRun
Name of the last run of the crawler that last synchronized this asset.- Specified by:
getLastSyncRunin interfaceIAsset
-
getLastSyncRunAt
Time (epoch) at which this asset was last crawled, in milliseconds.- Specified by:
getLastSyncRunAtin interfaceIAsset
-
getLastSyncWorkflowName
Name of the crawler that last synchronized this asset.- Specified by:
getLastSyncWorkflowNamein interfaceIAsset
-
getLexicographicalSortOrder
Custom order for sorting purpose, managed by client- Specified by:
getLexicographicalSortOrderin interfaceIAsset
-
getLinks
Links that are attached to this asset. -
getMcIncidents
TBC- Specified by:
getMcIncidentsin interfaceIAsset
-
getMcMonitors
Monitors that observe this asset.- Specified by:
getMcMonitorsin interfaceIAsset
-
getMetrics
TBC- Specified by:
getMetricsin interfaceIAsset
-
getName
Name of this asset. Fallback for display purposes, if displayName is empty. -
getNonCompliantAssetPolicyGUIDs
Array of policy ids non-compliant to this asset- Specified by:
getNonCompliantAssetPolicyGUIDsin interfaceIAsset
-
getOutputPortDataProducts
Data products for which this asset is an output port.- Specified by:
getOutputPortDataProductsin interfaceIAsset
-
getOutputProductGUIDs
Array of product guids which have this asset as outputPort- Specified by:
getOutputProductGUIDsin interfaceIAsset
-
getOwnerGroups
List of groups who own this asset.- Specified by:
getOwnerGroupsin interfaceIAsset
-
getOwnerUsers
List of users who own this asset.- Specified by:
getOwnerUsersin interfaceIAsset
-
getPopularityScore
Popularity score for this asset.- Specified by:
getPopularityScorein interfaceIAsset
-
getProductGUIDs
Array of product guids linked to this asset- Specified by:
getProductGUIDsin interfaceIAsset
-
getReadme
README that is linked to this asset. -
getSampleDataUrl
URL for sample data for this asset.- Specified by:
getSampleDataUrlin interfaceIAsset
-
getSchemaRegistrySubjects
TBC- Specified by:
getSchemaRegistrySubjectsin interfaceIAsset
-
getSodaChecks
TBC- Specified by:
getSodaChecksin interfaceIAsset
-
getSourceCostUnit
The unit of measure for sourceTotalCost.- Specified by:
getSourceCostUnitin interfaceIAsset
-
getSourceCreatedAt
Time (epoch) at which this asset was created in the source system, in milliseconds.- Specified by:
getSourceCreatedAtin interfaceIAsset
-
getSourceCreatedBy
Name of the user who created this asset, in the source system.- Specified by:
getSourceCreatedByin interfaceIAsset
-
getSourceEmbedURL
URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.- Specified by:
getSourceEmbedURLin interfaceIAsset
-
getSourceLastReadAt
Timestamp of most recent read operation.- Specified by:
getSourceLastReadAtin interfaceIAsset
-
getSourceOwners
List of owners of this asset, in the source system.- Specified by:
getSourceOwnersin interfaceIAsset
-
getSourceQueryComputeCostRecords
List of most expensive warehouses with extra insights.- Specified by:
getSourceQueryComputeCostRecordsin interfaceIAsset
-
getSourceQueryComputeCosts
List of most expensive warehouse names.- Specified by:
getSourceQueryComputeCostsin interfaceIAsset
-
getSourceReadCount
Total count of all read operations at source.- Specified by:
getSourceReadCountin interfaceIAsset
-
getSourceReadExpensiveQueryRecords
List of the most expensive queries that accessed this asset.- Specified by:
getSourceReadExpensiveQueryRecordsin interfaceIAsset
-
getSourceReadPopularQueryRecords
List of the most popular queries that accessed this asset.- Specified by:
getSourceReadPopularQueryRecordsin interfaceIAsset
-
getSourceReadQueryCost
Total cost of read queries at source.- Specified by:
getSourceReadQueryCostin interfaceIAsset
-
getSourceReadRecentUserRecords
List of usernames with extra insights for the most recent users who read this asset.- Specified by:
getSourceReadRecentUserRecordsin interfaceIAsset
-
getSourceReadRecentUsers
List of usernames of the most recent users who read this asset.- Specified by:
getSourceReadRecentUsersin interfaceIAsset
-
getSourceReadSlowQueryRecords
List of the slowest queries that accessed this asset.- Specified by:
getSourceReadSlowQueryRecordsin interfaceIAsset
-
getSourceReadTopUserRecords
List of usernames with extra insights for the users who read this asset the most.- Specified by:
getSourceReadTopUserRecordsin interfaceIAsset
-
getSourceReadTopUsers
List of usernames of the users who read this asset the most.- Specified by:
getSourceReadTopUsersin interfaceIAsset
-
getSourceReadUserCount
Total number of unique users that read data from asset.- Specified by:
getSourceReadUserCountin interfaceIAsset
-
getSourceTotalCost
Total cost of all operations at source.- Specified by:
getSourceTotalCostin interfaceIAsset
-
getSourceURL
URL to the resource within the source application, used to create a button to view this asset in the source application.- Specified by:
getSourceURLin interfaceIAsset
-
getSourceUpdatedAt
Time (epoch) at which this asset was last updated in the source system, in milliseconds.- Specified by:
getSourceUpdatedAtin interfaceIAsset
-
getSourceUpdatedBy
Name of the user who last updated this asset, in the source system.- Specified by:
getSourceUpdatedByin interfaceIAsset
-
getStarredBy
Users who have starred this asset.- Specified by:
getStarredByin interfaceIAsset
-
getStarredCount
Number of users who have starred this asset.- Specified by:
getStarredCountin interfaceIAsset
-
getStarredDetails
List of usernames with extra information of the users who have starred an asset.- Specified by:
getStarredDetailsin interfaceIAsset
-
getSubType
Subtype of this asset.- Specified by:
getSubTypein interfaceIAsset
-
getTenantId
Name of the Atlan workspace in which this asset exists.- Specified by:
getTenantIdin interfaceIAsset
-
getUserDefRelationshipFroms
TBC- Specified by:
getUserDefRelationshipFromsin interfaceIAsset
-
getUserDefRelationshipTos
TBC- Specified by:
getUserDefRelationshipTosin interfaceIAsset
-
getUserDescription
Description of this asset, as provided by a user. If present, this will be used for the description in user interface.- Specified by:
getUserDescriptionin interfaceIAsset
-
getViewScore
View score for this asset.- Specified by:
getViewScorein interfaceIAsset
-
getViewerGroups
List of groups who can view assets contained in a collection. (This is only used for certain asset types.)- Specified by:
getViewerGroupsin interfaceIAsset
-
getViewerUsers
List of users who can view assets contained in a collection. (This is only used for certain asset types.)- Specified by:
getViewerUsersin interfaceIAsset
-
getIconUrl
URL of an icon to use for this asset. (Only applies to CustomEntity and Fivetran Catalog assets, currently.)- Specified by:
getIconUrlin interfaceIAsset
-
getConnectorType
Built-in connector type through which this asset is accessible.- Specified by:
getConnectorTypein interfaceIAsset
-
getCustomConnectorType
Custom connector type through which this asset is accessible.- Specified by:
getCustomConnectorTypein interfaceIAsset
-
getAtlanTags
Atlan tags assigned to the asset.- Specified by:
getAtlanTagsin interfaceIReferenceable
-
getCustomMetadataSets
Map of custom metadata attributes and values defined on the asset. The map is keyed by the human-readable name of the custom metadata set, and the values are a further mapping from human-readable attribute name to the value for that attribute on this asset.- Specified by:
getCustomMetadataSetsin interfaceIReferenceable
-
getStatus
Status of the asset.- Specified by:
getStatusin interfaceIReferenceable
-
getCreatedBy
User or account that created the asset.- Specified by:
getCreatedByin interfaceIReferenceable
-
getUpdatedBy
User or account that last updated the asset.- Specified by:
getUpdatedByin interfaceIReferenceable
-
getCreateTime
Time (epoch) at which the asset was created, in milliseconds.- Specified by:
getCreateTimein interfaceIReferenceable
-
getUpdateTime
Time (epoch) at which the asset was last updated, in milliseconds.- Specified by:
getUpdateTimein interfaceIReferenceable
-
getDeleteHandler
Details on the handler used for deletion of the asset.- Specified by:
getDeleteHandlerin interfaceIReferenceable
-
getDepth
Depth of this asset within lineage. Note: this will only be available in assets retrieved via lineage, and will vary even for the same asset depending on the starting point of the lineage requested. -
getImmediateUpstream
Reference details about the asset(s) that are immediately upstream of this asset within lineage. Note: this will only be available in assets retrieved via lineage whenimmediateNeighborsis true, and could vary even for the same asset depending on the starting point and depth of the lineage requested. -
getImmediateDownstream
Reference details about the asset(s) that are immediately downstream of this asset within lineage. Note: this will only be available in assets retrieved via lineage whenimmediateNeighborsis true, and could vary even for the same asset depending on the starting point and depth of the lineage requested. -
getAtlanTagNames
Deprecated.The names of the Atlan tags that exist on the asset. This is not always returned, even by full retrieval operations. It is better to depend on the detailed values in the Atlan tags property.- Specified by:
getAtlanTagNamesin interfaceIReferenceable- See Also:
-
getIsIncomplete
Unused.- Specified by:
getIsIncompletein interfaceIReferenceable
-
getMeaningNames
Names of terms that have been linked to this asset.- Specified by:
getMeaningNamesin interfaceIReferenceable
-
getMeanings
Deprecated.seeassignedTermsinsteadDetails of terms that have been linked to this asset. This is not set by all API endpoints, so cannot be relied upon in general, even when there are terms assigned to an asset.- Specified by:
getMeaningsin interfaceIReferenceable
-
getPendingTasks
Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset.- Specified by:
getPendingTasksin interfaceIReferenceable
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
Description copied from class:AtlanObject
-
Asset.AssetBuilder.appendAtlanTags(List)