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, AirflowDag, AirflowTask, AnomaloCheck, APIField, APIObject, APIPath, APIQuery, APISpec, ApplicationContainer, AtlanCollection, AtlanQuery, AuthPolicy, AuthService, AzureEventHub, AzureEventHubConsumerGroup, AzureServiceBusNamespace, AzureServiceBusTopic, Badge, BIProcess, BusinessPolicy, BusinessPolicyException, BusinessPolicyIncident, BusinessPolicyLog, CalculationView, Cognite3DModel, CogniteAsset, CogniteEvent, CogniteFile, CogniteSequence, CogniteTimeSeries, CognosDashboard, CognosDatasource, CognosExploration, CognosFile, CognosFolder, CognosModule, CognosPackage, CognosReport, Column, ColumnProcess, Connection, CosmosMongoDBAccount, CosmosMongoDBCollection, CosmosMongoDBDatabase, Cube, CubeDimension, CubeField, CubeHierarchy, Database, DatabricksUnityCatalogTag, DataContract, DataDomain, DataProduct, DataStudioAsset, DbtColumnProcess, DbtMetric, DbtModel, DbtModelColumn, DbtProcess, DbtSource, DbtTag, DbtTest, DomoCard, DomoDashboard, DomoDataset, DomoDatasetColumn, DynamoDBGlobalSecondaryIndex, DynamoDBLocalSecondaryIndex, DynamoDBTable, File, FivetranConnector, Folder, 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, MicroStrategyCube, MicroStrategyDocument, MicroStrategyDossier, MicroStrategyFact, MicroStrategyMetric, MicroStrategyProject, MicroStrategyReport, MicroStrategyVisualization, ModeChart, ModeCollection, ModelAttribute, ModelAttributeAssociation, ModelDataModel, ModelEntity, ModelEntityAssociation, ModelVersion, ModeQuery, ModeReport, ModeWorkspace, MongoDBCollection, MongoDBDatabase, Persona, PowerBIColumn, PowerBIDashboard, PowerBIDataflow, PowerBIDataset, PowerBIDatasource, PowerBIMeasure, PowerBIPage, PowerBIReport, PowerBITable, PowerBITile, PowerBIWorkspace, PresetChart, PresetDashboard, PresetDataset, PresetWorkspace, Procedure, Purpose, QlikApp, QlikChart, QlikDataset, QlikSheet, QlikSpace, QlikStream, QuickSightAnalysis, QuickSightAnalysisVisual, QuickSightDashboard, QuickSightDashboardVisual, QuickSightDataset, QuickSightDatasetField, QuickSightFolder, Readme, ReadmeTemplate, RedashDashboard, RedashQuery, RedashVisualization, S3Bucket, S3Object, SalesforceDashboard, SalesforceField, SalesforceObject, SalesforceOrganization, SalesforceReport, Schema, SchemaRegistrySubject, SigmaDataElement, SigmaDataElementField, SigmaDataset, SigmaDatasetColumn, SigmaPage, SigmaWorkbook, SisenseDashboard, SisenseDatamodel, SisenseDatamodelTable, SisenseFolder, SisenseWidget, SnowflakeDynamicTable, SnowflakePipe, SnowflakeStream, SnowflakeTag, SodaCheck, SparkJob, Stakeholder, StakeholderTitle, SupersetChart, SupersetDashboard, SupersetDataset, Table, TableauCalculatedField, TableauDashboard, TableauDatasource, TableauDatasourceField, TableauFlow, TableauMetric, TableauProject, TableauSite, TableauWorkbook, TableauWorksheet, 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:

  • Constructor Details

  • Method Details

    • getNullFields

      public Set<String> getNullFields()
      Retrieve the list of fields to be serialized with null values.

    • getQualifiedName

      public String 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:
      getQualifiedName in interface IAsset
      Specified by:
      getQualifiedName in interface IReferenceable

    • getCustomMetadata

      public Object getCustomMetadata(String setName, String attrName)
      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 value
      attrName - 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

      public Asset.AssetBuilder<?,?> trimToRequired() throws InvalidRequestException
      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

      public Asset trimToReference() throws InvalidRequestException
      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

      public AssetMutationResponse save() throws AtlanException
      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.
      Returns:
      details of the created or updated asset
      Throws:
      AtlanException - on any error during the API invocation

    • save

      public AssetMutationResponse save(AtlanClient client) throws AtlanException
      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

      public AssetMutationResponse save(boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() method. If an asset does exist, optionally overwrites any Atlan tags. Custom metadata will always be entirely ignored using this method.
      Parameters:
      replaceAtlanTags - 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

    • save

      public AssetMutationResponse save(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() 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 asset
      replaceAtlanTags - 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

      public AssetMutationResponse saveMergingCM(boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() 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:
      replaceAtlanTags - 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

    • saveMergingCM

      public AssetMutationResponse saveMergingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() 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 saved
      replaceAtlanTags - 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

      public AssetMutationResponse saveReplacingCM(boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() 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:
      replaceAtlanTags - 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

    • saveReplacingCM

      public AssetMutationResponse saveReplacingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      If no asset exists, has the same behavior as the save() 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 saved
      replaceAtlanTags - 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

      public AssetMutationResponse updateMergingCM(boolean replaceAtlanTags) throws AtlanException
      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:
      replaceAtlanTags - 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 invocation
      NotFoundException - if the asset does not exist (will not create it)

    • updateMergingCM

      public AssetMutationResponse updateMergingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      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 saved
      replaceAtlanTags - 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 invocation
      NotFoundException - if the asset does not exist (will not create it)

    • updateReplacingCM

      public AssetMutationResponse updateReplacingCM(boolean replaceAtlanTags) throws AtlanException
      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:
      replaceAtlanTags - 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 invocation
      NotFoundException - if the asset does not exist (will not create it)

    • updateReplacingCM

      public AssetMutationResponse updateReplacingCM(AtlanClient client, boolean replaceAtlanTags) throws AtlanException
      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 saved
      replaceAtlanTags - 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 invocation
      NotFoundException - if the asset does not exist (will not create it)

    • requestLineage

      public FluentLineage.FluentLineageBuilder 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.)
      Returns:
      a fluent lineage request that includes all active downstream assets

    • requestLineage

      public FluentLineage.FluentLineageBuilder requestLineage(AtlanClient client)
      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(String assetGuid, String impersonationToken) throws AtlanException
      Add the API token configured for the default client as an admin to this object.
      Parameters:
      assetGuid - unique identifier (GUID) of the asset to which we should add this API token as an admin
      impersonationToken - 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 includeRelationships) 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 asset
      guid - of the asset to retrieve
      includeRelationships - if true, all of 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 the NotFoundException if the asset does not exist

    • get

      public static Asset get(AtlanClient client, String typeName, String qualifiedName, boolean includeRelationships) 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 asset
      typeName - the type of the asset to retrieve
      qualifiedName - the unique name of the asset to retrieve
      includeRelationships - if true, all of 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 the NotFoundException if the asset does not exist

    • delete

      public static AssetDeletionResponse delete(String guid) throws AtlanException
      Soft-deletes an asset by its GUID. This operation can be reversed by updating the asset and changing its status to ACTIVE.
      Parameters:
      guid - of the asset to soft-delete
      Returns:
      details of the soft-deleted asset
      Throws:
      AtlanException - on any error during the API invocation

    • delete

      public static AssetDeletionResponse delete(AtlanClient client, String guid) throws AtlanException
      Soft-deletes an asset by its GUID. This operation can be reversed by updating the asset and changing its status to ACTIVE.
      Parameters:
      client - connectivity to the Atlan tenant from which to delete the asset
      guid - of the asset to soft-delete
      Returns:
      details of the soft-deleted asset
      Throws:
      AtlanException - on any error during the API invocation

    • purge

      public static AssetDeletionResponse purge(String guid) throws AtlanException
      Hard-deletes (purges) an asset by its GUID. This operation is irreversible.
      Parameters:
      guid - of the asset to hard-delete
      Returns:
      details of the hard-deleted asset
      Throws:
      AtlanException - on any error during the API invocation

    • purge

      public static AssetDeletionResponse purge(AtlanClient client, String guid) throws AtlanException
      Hard-deletes (purges) an asset by its GUID. This operation is irreversible.
      Parameters:
      client - connectivity to the Atlan tenant from which to delete the asset
      guid - of the asset to hard-delete
      Returns:
      details of the hard-deleted asset
      Throws:
      AtlanException - on any error during the API invocation

    • lineage

      public static FluentLineage.FluentLineageBuilder lineage(String guid)
      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:
      guid - 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)
      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 assets
      guid - 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(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:
      guid - unique identifier (GUID) for the starting point of lineage
      includeArchived - when true, archived (soft-deleted) assets in lineage will be included
      Returns:
      a fluent lineage request that includes all 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 lineage
      guid - unique identifier (GUID) for the starting point of lineage
      includeArchived - 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(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:
      guid - unique identifier of the asset
      cmName - human-readable name of the custom metadata to update
      attributes - 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

    • 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 attributes
      guid - unique identifier of the asset
      cmName - human-readable name of the custom metadata to update
      attributes - 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(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:
      guid - unique identifier of the asset
      cmName - human-readable name of the custom metadata to replace
      attributes - 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

    • 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 metadata
      guid - unique identifier of the asset
      cmName - human-readable name of the custom metadata to replace
      attributes - 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(String guid, String cmName) throws AtlanException
      Remove specific custom metadata from an asset.
      Parameters:
      guid - unique identifier of the asset
      cmName - 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

    • 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 metadata
      guid - unique identifier of the asset
      cmName - 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

      protected static Asset appendAtlanTags(AtlanClient client, String typeName, String qualifiedName, List<String> atlanTagNames) 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 append Atlan tags to the asset
      typeName - type of the asset
      qualifiedName - of the asset
      atlanTagNames - human-readable names of the Atlan tags to append
      Returns:
      the asset that was updated
      Throws:
      AtlanException - on any API problems

    • appendAtlanTags

      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 asset
      typeName - type of the asset
      qualifiedName - of the asset
      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 asset that was updated
      Throws:
      AtlanException - on any API problems

    • removeAtlanTag

      protected static void removeAtlanTag(AtlanClient client, String typeName, String qualifiedName, String atlanTagName) throws AtlanException
      Remove an Atlan tag from an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the Atlan tag from the asset
      typeName - type of the asset
      qualifiedName - of the asset
      atlanTagName - 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 AtlanException
      Update the certificate on an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the asset's certificate
      builder - the builder to use for updating the certificate
      certificate - certificate to set
      message - (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 AtlanException
      Remove the certificate on an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's certificate
      builder - 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 AtlanException
      Update the announcement on an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the asset's announcement
      builder - the builder to use for updating the announcement
      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

      protected static Asset removeAnnouncement(AtlanClient client, Asset.AssetBuilder<?,?> builder) throws AtlanException
      Remove the announcement on an asset.
      Parameters:
      client - connectivity to the Atlan tenant from which to remove the asset's announcement
      builder - 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 AtlanException
      Remove the system description from an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      builder - 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 AtlanException
      Remove the user-provided description from an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's description
      builder - 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 AtlanException
      Remove the owners from an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to remove the asset's owners
      builder - 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 AtlanException
      Update the certificate on an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the asset's certificate
      builder - the builder to use for updating the certificate
      typeName - type of the asset
      qualifiedName - for the asset
      certificate - certificate to set
      message - (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 AtlanException
      Update the announcement on an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to update the asset's announcement
      builder - the builder to use for updating the announcement
      typeName - type of the asset
      qualifiedName - for the asset
      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

    • 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 asset
      typeName - type of the asset to restore
      qualifiedName - 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 AtlanException
      Replace the terms linked to an asset.
      Parameters:
      client - connectivity to the Atlan tenant on which to replace the asset's terms
      builder - the builder to use for updating the terms
      terms - 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

      protected static Asset appendTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      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 asset
      typeName - type of the asset
      qualifiedName - for the asset
      terms - 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

      protected static Asset removeTerms(AtlanClient client, String typeName, String qualifiedName, List<IGlossaryTerm> terms) throws AtlanException
      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 asset
      typeName - type of the asset
      qualifiedName - for the asset
      terms - 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 problems
      InvalidRequestException - if any of the passed terms are not valid references by GUID to a term

    • getAdminGroups

      public SortedSet<String> getAdminGroups()
      List of groups who administer this asset. (This is only used for certain asset types.)
      Specified by:
      getAdminGroups in interface IAsset

    • getAdminRoles

      public SortedSet<String> getAdminRoles()
      List of roles who administer this asset. (This is only used for Connection assets.)
      Specified by:
      getAdminRoles in interface IAsset

    • getAdminUsers

      public SortedSet<String> getAdminUsers()
      List of users who administer this asset. (This is only used for certain asset types.)
      Specified by:
      getAdminUsers in interface IAsset

    • getAnnouncementMessage

      public String getAnnouncementMessage()
      Detailed message to include in the announcement on this asset.
      Specified by:
      getAnnouncementMessage in interface IAsset

    • getAnnouncementTitle

      public String getAnnouncementTitle()
      Brief title for the announcement on this asset. Required when announcementType is specified.
      Specified by:
      getAnnouncementTitle in interface IAsset

    • getAnnouncementType

      public AtlanAnnouncementType getAnnouncementType()
      Type of announcement on this asset.
      Specified by:
      getAnnouncementType in interface IAsset

    • getAnnouncementUpdatedAt

      public Long getAnnouncementUpdatedAt()
      Time (epoch) at which the announcement was last updated, in milliseconds.
      Specified by:
      getAnnouncementUpdatedAt in interface IAsset

    • getAnnouncementUpdatedBy

      public String getAnnouncementUpdatedBy()
      Name of the user who last updated the announcement.
      Specified by:
      getAnnouncementUpdatedBy in interface IAsset

    • getAnomaloChecks

      public SortedSet<IAnomaloCheck> getAnomaloChecks()
      Checks that run on this asset.
      Specified by:
      getAnomaloChecks in interface IAsset

    • getAssetAnomaloAppliedCheckTypes

      public SortedSet<String> getAssetAnomaloAppliedCheckTypes()
      All associated Anomalo check types.
      Specified by:
      getAssetAnomaloAppliedCheckTypes in interface IAsset

    • getAssetAnomaloCheckCount

      public Long getAssetAnomaloCheckCount()
      Total number of checks present in Anomalo for this asset.
      Specified by:
      getAssetAnomaloCheckCount in interface IAsset

    • getAssetAnomaloCheckStatuses

      public String getAssetAnomaloCheckStatuses()
      Stringified JSON object containing status of all Anomalo checks associated to this asset.
      Specified by:
      getAssetAnomaloCheckStatuses in interface IAsset

    • getAssetAnomaloDQStatus

      public String getAssetAnomaloDQStatus()
      Status of data quality from Anomalo.
      Specified by:
      getAssetAnomaloDQStatus in interface IAsset

    • getAssetAnomaloFailedCheckCount

      public Long getAssetAnomaloFailedCheckCount()
      Total number of checks failed in Anomalo for this asset.
      Specified by:
      getAssetAnomaloFailedCheckCount in interface IAsset

    • getAssetAnomaloFailedCheckTypes

      public SortedSet<String> getAssetAnomaloFailedCheckTypes()
      All associated Anomalo failed check types.
      Specified by:
      getAssetAnomaloFailedCheckTypes in interface IAsset

    • getAssetAnomaloLastCheckRunAt

      public Long getAssetAnomaloLastCheckRunAt()
      Time (epoch) at which the last check was run via Anomalo.
      Specified by:
      getAssetAnomaloLastCheckRunAt in interface IAsset

    • getAssetAnomaloSourceUrl

      public String getAssetAnomaloSourceUrl()
      URL of the source in Anomalo.
      Specified by:
      getAssetAnomaloSourceUrl in interface IAsset

    • getAssetCoverImage

      public String getAssetCoverImage()
      TBC
      Specified by:
      getAssetCoverImage in interface IAsset

    • getAssetDbtAccountName

      public String getAssetDbtAccountName()
      Name of the account in which this asset exists in dbt.
      Specified by:
      getAssetDbtAccountName in interface IAsset

    • getAssetDbtAlias

      public String getAssetDbtAlias()
      Alias of this asset in dbt.
      Specified by:
      getAssetDbtAlias in interface IAsset

    • getAssetDbtEnvironmentDbtVersion

      public String getAssetDbtEnvironmentDbtVersion()
      Version of the environment in which this asset is materialized in dbt.
      Specified by:
      getAssetDbtEnvironmentDbtVersion in interface IAsset

    • getAssetDbtEnvironmentName

      public String getAssetDbtEnvironmentName()
      Name of the environment in which this asset is materialized in dbt.
      Specified by:
      getAssetDbtEnvironmentName in interface IAsset

    • getAssetDbtJobLastRun

      public Long getAssetDbtJobLastRun()
      Time (epoch) at which the job that materialized this asset in dbt last ran, in milliseconds.
      Specified by:
      getAssetDbtJobLastRun in interface IAsset

    • getAssetDbtJobLastRunArtifactS3Path

      public String getAssetDbtJobLastRunArtifactS3Path()
      Path in S3 to the artifacts saved from the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunArtifactS3Path in interface IAsset

    • getAssetDbtJobLastRunArtifactsSaved

      public Boolean getAssetDbtJobLastRunArtifactsSaved()
      Whether artifacts were saved from the last run of the job that materialized this asset in dbt (true) or not (false).
      Specified by:
      getAssetDbtJobLastRunArtifactsSaved in interface IAsset

    • getAssetDbtJobLastRunCreatedAt

      public Long getAssetDbtJobLastRunCreatedAt()
      Time (epoch) at which the job that materialized this asset in dbt was last created, in milliseconds.
      Specified by:
      getAssetDbtJobLastRunCreatedAt in interface IAsset

    • getAssetDbtJobLastRunDequedAt

      public Long getAssetDbtJobLastRunDequedAt()
      Time (epoch) at which the job that materialized this asset in dbt was dequeued, in milliseconds.
      Specified by:
      getAssetDbtJobLastRunDequedAt in interface IAsset

    • getAssetDbtJobLastRunExecutedByThreadId

      public String getAssetDbtJobLastRunExecutedByThreadId()
      Thread ID of the user who executed the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunExecutedByThreadId in interface IAsset

    • getAssetDbtJobLastRunGitBranch

      public String getAssetDbtJobLastRunGitBranch()
      Branch in git from which the last run of the job that materialized this asset in dbt ran.
      Specified by:
      getAssetDbtJobLastRunGitBranch in interface IAsset

    • getAssetDbtJobLastRunGitSha

      public String getAssetDbtJobLastRunGitSha()
      SHA hash in git for the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunGitSha in interface IAsset

    • getAssetDbtJobLastRunHasDocsGenerated

      public Boolean getAssetDbtJobLastRunHasDocsGenerated()
      Whether docs were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
      Specified by:
      getAssetDbtJobLastRunHasDocsGenerated in interface IAsset

    • getAssetDbtJobLastRunHasSourcesGenerated

      public Boolean getAssetDbtJobLastRunHasSourcesGenerated()
      Whether sources were generated from the last run of the job that materialized this asset in dbt (true) or not (false).
      Specified by:
      getAssetDbtJobLastRunHasSourcesGenerated in interface IAsset

    • getAssetDbtJobLastRunNotificationsSent

      public Boolean getAssetDbtJobLastRunNotificationsSent()
      Whether notifications were sent from the last run of the job that materialized this asset in dbt (true) or not (false).
      Specified by:
      getAssetDbtJobLastRunNotificationsSent in interface IAsset

    • getAssetDbtJobLastRunOwnerThreadId

      public String getAssetDbtJobLastRunOwnerThreadId()
      Thread ID of the owner of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunOwnerThreadId in interface IAsset

    • getAssetDbtJobLastRunQueuedDuration

      public String getAssetDbtJobLastRunQueuedDuration()
      Total duration the job that materialized this asset in dbt spent being queued.
      Specified by:
      getAssetDbtJobLastRunQueuedDuration in interface IAsset

    • getAssetDbtJobLastRunQueuedDurationHumanized

      public String getAssetDbtJobLastRunQueuedDurationHumanized()
      Human-readable total duration of the last run of the job that materialized this asset in dbt spend being queued.
      Specified by:
      getAssetDbtJobLastRunQueuedDurationHumanized in interface IAsset

    • getAssetDbtJobLastRunRunDuration

      public String getAssetDbtJobLastRunRunDuration()
      Run duration of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunRunDuration in interface IAsset

    • getAssetDbtJobLastRunRunDurationHumanized

      public String getAssetDbtJobLastRunRunDurationHumanized()
      Human-readable run duration of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunRunDurationHumanized in interface IAsset

    • getAssetDbtJobLastRunStartedAt

      public Long getAssetDbtJobLastRunStartedAt()
      Time (epoch) at which the job that materialized this asset in dbt was started running, in milliseconds.
      Specified by:
      getAssetDbtJobLastRunStartedAt in interface IAsset

    • getAssetDbtJobLastRunStatusMessage

      public String getAssetDbtJobLastRunStatusMessage()
      Status message of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunStatusMessage in interface IAsset

    • getAssetDbtJobLastRunTotalDuration

      public String getAssetDbtJobLastRunTotalDuration()
      Total duration of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunTotalDuration in interface IAsset

    • getAssetDbtJobLastRunTotalDurationHumanized

      public String getAssetDbtJobLastRunTotalDurationHumanized()
      Human-readable total duration of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunTotalDurationHumanized in interface IAsset

    • getAssetDbtJobLastRunUpdatedAt

      public Long getAssetDbtJobLastRunUpdatedAt()
      Time (epoch) at which the job that materialized this asset in dbt was last updated, in milliseconds.
      Specified by:
      getAssetDbtJobLastRunUpdatedAt in interface IAsset

    • getAssetDbtJobLastRunUrl

      public String getAssetDbtJobLastRunUrl()
      URL of the last run of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobLastRunUrl in interface IAsset

    • getAssetDbtJobName

      public String getAssetDbtJobName()
      Name of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobName in interface IAsset

    • getAssetDbtJobNextRun

      public Long getAssetDbtJobNextRun()
      Time (epoch) when the next run of the job that materializes this asset in dbt is scheduled.
      Specified by:
      getAssetDbtJobNextRun in interface IAsset

    • getAssetDbtJobNextRunHumanized

      public String getAssetDbtJobNextRunHumanized()
      Human-readable time when the next run of the job that materializes this asset in dbt is scheduled.
      Specified by:
      getAssetDbtJobNextRunHumanized in interface IAsset

    • getAssetDbtJobSchedule

      public String getAssetDbtJobSchedule()
      Schedule of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobSchedule in interface IAsset

    • getAssetDbtJobScheduleCronHumanized

      public String getAssetDbtJobScheduleCronHumanized()
      Human-readable cron schedule of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobScheduleCronHumanized in interface IAsset

    • getAssetDbtJobStatus

      public String getAssetDbtJobStatus()
      Status of the job that materialized this asset in dbt.
      Specified by:
      getAssetDbtJobStatus in interface IAsset

    • getAssetDbtMeta

      public String getAssetDbtMeta()
      Metadata for this asset in dbt, specifically everything under the 'meta' key in the dbt object.
      Specified by:
      getAssetDbtMeta in interface IAsset

    • getAssetDbtPackageName

      public String getAssetDbtPackageName()
      Name of the package in which this asset exists in dbt.
      Specified by:
      getAssetDbtPackageName in interface IAsset

    • getAssetDbtProjectName

      public String getAssetDbtProjectName()
      Name of the project in which this asset exists in dbt.
      Specified by:
      getAssetDbtProjectName in interface IAsset

    • getAssetDbtSemanticLayerProxyUrl

      public String getAssetDbtSemanticLayerProxyUrl()
      URL of the semantic layer proxy for this asset in dbt.
      Specified by:
      getAssetDbtSemanticLayerProxyUrl in interface IAsset

    • getAssetDbtSourceFreshnessCriteria

      public String getAssetDbtSourceFreshnessCriteria()
      Freshness criteria for the source of this asset in dbt.
      Specified by:
      getAssetDbtSourceFreshnessCriteria in interface IAsset

    • getAssetDbtTags

      public SortedSet<String> getAssetDbtTags()
      List of tags attached to this asset in dbt.
      Specified by:
      getAssetDbtTags in interface IAsset

    • getAssetDbtTestStatus

      public String getAssetDbtTestStatus()
      All associated dbt test statuses.
      Specified by:
      getAssetDbtTestStatus in interface IAsset

    • getAssetDbtUniqueId

      public String getAssetDbtUniqueId()
      Unique identifier of this asset in dbt.
      Specified by:
      getAssetDbtUniqueId in interface IAsset

    • getAssetDbtWorkflowLastUpdated

      public String getAssetDbtWorkflowLastUpdated()
      Name of the DBT workflow in Atlan that last updated the asset.
      Specified by:
      getAssetDbtWorkflowLastUpdated in interface IAsset

    • getAssetIcon

      public AtlanIcon getAssetIcon()
      Name of the icon to use for this asset. (Only applies to glossaries, currently.)
      Specified by:
      getAssetIcon in interface IAsset

    • getAssetMcAlertQualifiedNames

      public SortedSet<String> getAssetMcAlertQualifiedNames()
      List of unique Monte Carlo alert names attached to this asset.
      Specified by:
      getAssetMcAlertQualifiedNames in interface IAsset

    • getAssetMcIncidentNames

      public SortedSet<String> getAssetMcIncidentNames()
      List of Monte Carlo incident names attached to this asset.
      Specified by:
      getAssetMcIncidentNames in interface IAsset

    • getAssetMcIncidentPriorities

      public SortedSet<String> getAssetMcIncidentPriorities()
      List of Monte Carlo incident priorities associated with this asset.
      Specified by:
      getAssetMcIncidentPriorities in interface IAsset

    • getAssetMcIncidentQualifiedNames

      public SortedSet<String> getAssetMcIncidentQualifiedNames()
      List of unique Monte Carlo incident names attached to this asset.
      Specified by:
      getAssetMcIncidentQualifiedNames in interface IAsset

    • getAssetMcIncidentSeverities

      public SortedSet<String> getAssetMcIncidentSeverities()
      List of Monte Carlo incident severities associated with this asset.
      Specified by:
      getAssetMcIncidentSeverities in interface IAsset

    • getAssetMcIncidentStates

      public SortedSet<String> getAssetMcIncidentStates()
      List of Monte Carlo incident states associated with this asset.
      Specified by:
      getAssetMcIncidentStates in interface IAsset

    • getAssetMcIncidentSubTypes

      public SortedSet<String> getAssetMcIncidentSubTypes()
      List of Monte Carlo incident sub-types associated with this asset.
      Specified by:
      getAssetMcIncidentSubTypes in interface IAsset

    • getAssetMcIncidentTypes

      public SortedSet<String> getAssetMcIncidentTypes()
      List of Monte Carlo incident types associated with this asset.
      Specified by:
      getAssetMcIncidentTypes in interface IAsset

    • getAssetMcLastSyncRunAt

      public Long getAssetMcLastSyncRunAt()
      Time (epoch) at which this asset was last synced from Monte Carlo.
      Specified by:
      getAssetMcLastSyncRunAt in interface IAsset

    • getAssetMcMonitorNames

      public SortedSet<String> getAssetMcMonitorNames()
      List of Monte Carlo monitor names attached to this asset.
      Specified by:
      getAssetMcMonitorNames in interface IAsset

    • getAssetMcMonitorQualifiedNames

      public SortedSet<String> getAssetMcMonitorQualifiedNames()
      List of unique Monte Carlo monitor names attached to this asset.
      Specified by:
      getAssetMcMonitorQualifiedNames in interface IAsset

    • getAssetMcMonitorScheduleTypes

      public SortedSet<String> getAssetMcMonitorScheduleTypes()
      Schedules of all associated Monte Carlo monitors.
      Specified by:
      getAssetMcMonitorScheduleTypes in interface IAsset

    • getAssetMcMonitorStatuses

      public SortedSet<String> getAssetMcMonitorStatuses()
      Statuses of all associated Monte Carlo monitors.
      Specified by:
      getAssetMcMonitorStatuses in interface IAsset

    • getAssetMcMonitorTypes

      public SortedSet<String> getAssetMcMonitorTypes()
      Types of all associated Monte Carlo monitors.
      Specified by:
      getAssetMcMonitorTypes in interface IAsset

    • getAssetPoliciesCount

      public Long getAssetPoliciesCount()
      Count of policies inside the asset
      Specified by:
      getAssetPoliciesCount in interface IAsset

    • getAssetPolicyGUIDs

      public SortedSet<String> getAssetPolicyGUIDs()
      Array of policy ids governing this asset
      Specified by:
      getAssetPolicyGUIDs in interface IAsset

    • getAssetSodaCheckCount

      public Long getAssetSodaCheckCount()
      Number of checks done via Soda.
      Specified by:
      getAssetSodaCheckCount in interface IAsset

    • getAssetSodaCheckStatuses

      public String getAssetSodaCheckStatuses()
      All associated Soda check statuses.
      Specified by:
      getAssetSodaCheckStatuses in interface IAsset

    • getAssetSodaDQStatus

      public String getAssetSodaDQStatus()
      Status of data quality from Soda.
      Specified by:
      getAssetSodaDQStatus in interface IAsset

    • getAssetSodaLastScanAt

      public Long getAssetSodaLastScanAt()
      TBC
      Specified by:
      getAssetSodaLastScanAt in interface IAsset

    • getAssetSodaLastSyncRunAt

      public Long getAssetSodaLastSyncRunAt()
      TBC
      Specified by:
      getAssetSodaLastSyncRunAt in interface IAsset

    • getAssetSodaSourceURL

      public String getAssetSodaSourceURL()
      TBC
      Specified by:
      getAssetSodaSourceURL in interface IAsset

    • getAssetTags

      public SortedSet<String> getAssetTags()
      List of tags attached to this asset.
      Specified by:
      getAssetTags in interface IAsset

    • getAssetThemeHex

      public String getAssetThemeHex()
      Color (in hexadecimal RGB) to use to represent this asset.
      Specified by:
      getAssetThemeHex in interface IAsset

    • getAssignedTerms

      public SortedSet<IGlossaryTerm> getAssignedTerms()
      Glossary terms that are linked to this asset.
      Specified by:
      getAssignedTerms in interface IAsset

    • getCertificateStatus

      public CertificateStatus getCertificateStatus()
      Status of this asset's certification.
      Specified by:
      getCertificateStatus in interface IAsset

    • getCertificateStatusMessage

      public String getCertificateStatusMessage()
      Human-readable descriptive message used to provide further detail to certificateStatus.
      Specified by:
      getCertificateStatusMessage in interface IAsset

    • getCertificateUpdatedAt

      public Long getCertificateUpdatedAt()
      Time (epoch) at which the certification was last updated, in milliseconds.
      Specified by:
      getCertificateUpdatedAt in interface IAsset

    • getCertificateUpdatedBy

      public String getCertificateUpdatedBy()
      Name of the user who last updated the certification of this asset.
      Specified by:
      getCertificateUpdatedBy in interface IAsset

    • getConnectionName

      public String getConnectionName()
      Simple name of the connection through which this asset is accessible.
      Specified by:
      getConnectionName in interface IAsset

    • getConnectionQualifiedName

      public String getConnectionQualifiedName()
      Unique name of the connection through which this asset is accessible.
      Specified by:
      getConnectionQualifiedName in interface IAsset

    • getConnectorType

      public AtlanConnectorType getConnectorType()
      Type of the connector through which this asset is accessible.
      Specified by:
      getConnectorType in interface IAsset

    • getDataContractLatest

      public IDataContract getDataContractLatest()
      Latest version of the data contract (in any status) for this asset.
      Specified by:
      getDataContractLatest in interface IAsset

    • getDataContractLatestCertified

      public IDataContract getDataContractLatestCertified()
      Latest certified version of the data contract for this asset.
      Specified by:
      getDataContractLatestCertified in interface IAsset

    • getDbtQualifiedName

      public String getDbtQualifiedName()
      Unique name of this asset in dbt.
      Specified by:
      getDbtQualifiedName in interface IAsset

    • getDescription

      public String getDescription()
      Description of this asset, for example as crawled from a source. Fallback for display purposes, if userDescription is empty.
      Specified by:
      getDescription in interface IAsset

    • getDisplayName

      public String getDisplayName()
      Human-readable name of this asset used for display purposes (in user interface).
      Specified by:
      getDisplayName in interface IAsset

    • getDomainGUIDs

      public SortedSet<String> getDomainGUIDs()
      Array of domain guids linked to this asset
      Specified by:
      getDomainGUIDs in interface IAsset

    • getFiles

      public SortedSet<IFile> getFiles()
      TBC
      Specified by:
      getFiles in interface IAsset

    • getHasContract

      public Boolean getHasContract()
      Whether this asset has contract (true) or not (false).
      Specified by:
      getHasContract in interface IAsset

    • getHasLineage

      public Boolean getHasLineage()
      Whether this asset has lineage (true) or not (false).
      Specified by:
      getHasLineage in interface IAsset

    • getInputPortDataProducts

      public SortedSet<IDataProduct> getInputPortDataProducts()
      Data products for which this asset is an input port.
      Specified by:
      getInputPortDataProducts in interface IAsset

    • getIsAIGenerated

      public Boolean getIsAIGenerated()
      TBC
      Specified by:
      getIsAIGenerated in interface IAsset

    • getIsDiscoverable

      public Boolean getIsDiscoverable()
      Whether this asset is discoverable through the UI (true) or not (false).
      Specified by:
      getIsDiscoverable in interface IAsset

    • getIsEditable

      public Boolean getIsEditable()
      Whether this asset can be edited in the UI (true) or not (false).
      Specified by:
      getIsEditable in interface IAsset

    • getIsPartial

      public Boolean getIsPartial()
      TBC
      Specified by:
      getIsPartial in interface IAsset

    • getLastRowChangedAt

      public Long getLastRowChangedAt()
      Time (epoch) of the last operation that inserted, updated, or deleted rows, in milliseconds.
      Specified by:
      getLastRowChangedAt in interface IAsset

    • getLastSyncRun

      public String getLastSyncRun()
      Name of the last run of the crawler that last synchronized this asset.
      Specified by:
      getLastSyncRun in interface IAsset

    • getLastSyncRunAt

      public Long getLastSyncRunAt()
      Time (epoch) at which this asset was last crawled, in milliseconds.
      Specified by:
      getLastSyncRunAt in interface IAsset

    • getLastSyncWorkflowName

      public String getLastSyncWorkflowName()
      Name of the crawler that last synchronized this asset.
      Specified by:
      getLastSyncWorkflowName in interface IAsset

    • getLexicographicalSortOrder

      public String getLexicographicalSortOrder()
      Custom order for sorting purpose, managed by client
      Specified by:
      getLexicographicalSortOrder in interface IAsset

    • getLinks

      public SortedSet<ILink> getLinks()
      Links that are attached to this asset.
      Specified by:
      getLinks in interface IAsset

    • getMcIncidents

      public SortedSet<IMCIncident> getMcIncidents()
      TBC
      Specified by:
      getMcIncidents in interface IAsset

    • getMcMonitors

      public SortedSet<IMCMonitor> getMcMonitors()
      Monitors that observe this asset.
      Specified by:
      getMcMonitors in interface IAsset

    • getMetrics

      public SortedSet<IMetric> getMetrics()
      TBC
      Specified by:
      getMetrics in interface IAsset

    • getName

      public String getName()
      Name of this asset. Fallback for display purposes, if displayName is empty.
      Specified by:
      getName in interface IAsset

    • getNonCompliantAssetPolicyGUIDs

      public SortedSet<String> getNonCompliantAssetPolicyGUIDs()
      Array of policy ids non-compliant to this asset
      Specified by:
      getNonCompliantAssetPolicyGUIDs in interface IAsset

    • getOutputPortDataProducts

      public SortedSet<IDataProduct> getOutputPortDataProducts()
      Data products for which this asset is an output port.
      Specified by:
      getOutputPortDataProducts in interface IAsset

    • getOwnerGroups

      public SortedSet<String> getOwnerGroups()
      List of groups who own this asset.
      Specified by:
      getOwnerGroups in interface IAsset

    • getOwnerUsers

      public SortedSet<String> getOwnerUsers()
      List of users who own this asset.
      Specified by:
      getOwnerUsers in interface IAsset

    • getPopularityScore

      public Double getPopularityScore()
      Popularity score for this asset.
      Specified by:
      getPopularityScore in interface IAsset

    • getReadme

      public IReadme getReadme()
      README that is linked to this asset.
      Specified by:
      getReadme in interface IAsset

    • getSampleDataUrl

      public String getSampleDataUrl()
      URL for sample data for this asset.
      Specified by:
      getSampleDataUrl in interface IAsset

    • getSchemaRegistrySubjects

      public SortedSet<ISchemaRegistrySubject> getSchemaRegistrySubjects()
      TBC
      Specified by:
      getSchemaRegistrySubjects in interface IAsset

    • getSodaChecks

      public SortedSet<ISodaCheck> getSodaChecks()
      TBC
      Specified by:
      getSodaChecks in interface IAsset

    • getSourceCostUnit

      public SourceCostUnitType getSourceCostUnit()
      The unit of measure for sourceTotalCost.
      Specified by:
      getSourceCostUnit in interface IAsset

    • getSourceCreatedAt

      public Long getSourceCreatedAt()
      Time (epoch) at which this asset was created in the source system, in milliseconds.
      Specified by:
      getSourceCreatedAt in interface IAsset

    • getSourceCreatedBy

      public String getSourceCreatedBy()
      Name of the user who created this asset, in the source system.
      Specified by:
      getSourceCreatedBy in interface IAsset

    • getSourceEmbedURL

      public String getSourceEmbedURL()
      URL to create an embed for a resource (for example, an image of a dashboard) within Atlan.
      Specified by:
      getSourceEmbedURL in interface IAsset

    • getSourceLastReadAt

      public Long getSourceLastReadAt()
      Timestamp of most recent read operation.
      Specified by:
      getSourceLastReadAt in interface IAsset

    • getSourceOwners

      public String getSourceOwners()
      List of owners of this asset, in the source system.
      Specified by:
      getSourceOwners in interface IAsset

    • getSourceQueryComputeCostRecords

      public List<PopularityInsights> getSourceQueryComputeCostRecords()
      List of most expensive warehouses with extra insights.
      Specified by:
      getSourceQueryComputeCostRecords in interface IAsset

    • getSourceQueryComputeCosts

      public SortedSet<String> getSourceQueryComputeCosts()
      List of most expensive warehouse names.
      Specified by:
      getSourceQueryComputeCosts in interface IAsset

    • getSourceReadCount

      public Long getSourceReadCount()
      Total count of all read operations at source.
      Specified by:
      getSourceReadCount in interface IAsset

    • getSourceReadExpensiveQueryRecords

      public List<PopularityInsights> getSourceReadExpensiveQueryRecords()
      List of the most expensive queries that accessed this asset.
      Specified by:
      getSourceReadExpensiveQueryRecords in interface IAsset

    • getSourceReadPopularQueryRecords

      public List<PopularityInsights> getSourceReadPopularQueryRecords()
      List of the most popular queries that accessed this asset.
      Specified by:
      getSourceReadPopularQueryRecords in interface IAsset

    • getSourceReadQueryCost

      public Double getSourceReadQueryCost()
      Total cost of read queries at source.
      Specified by:
      getSourceReadQueryCost in interface IAsset

    • getSourceReadRecentUserRecords

      public List<PopularityInsights> getSourceReadRecentUserRecords()
      List of usernames with extra insights for the most recent users who read this asset.
      Specified by:
      getSourceReadRecentUserRecords in interface IAsset

    • getSourceReadRecentUsers

      public SortedSet<String> getSourceReadRecentUsers()
      List of usernames of the most recent users who read this asset.
      Specified by:
      getSourceReadRecentUsers in interface IAsset

    • getSourceReadSlowQueryRecords

      public List<PopularityInsights> getSourceReadSlowQueryRecords()
      List of the slowest queries that accessed this asset.
      Specified by:
      getSourceReadSlowQueryRecords in interface IAsset

    • getSourceReadTopUserRecords

      public List<PopularityInsights> getSourceReadTopUserRecords()
      List of usernames with extra insights for the users who read this asset the most.
      Specified by:
      getSourceReadTopUserRecords in interface IAsset

    • getSourceReadTopUsers

      public SortedSet<String> getSourceReadTopUsers()
      List of usernames of the users who read this asset the most.
      Specified by:
      getSourceReadTopUsers in interface IAsset

    • getSourceReadUserCount

      public Long getSourceReadUserCount()
      Total number of unique users that read data from asset.
      Specified by:
      getSourceReadUserCount in interface IAsset

    • getSourceTotalCost

      public Double getSourceTotalCost()
      Total cost of all operations at source.
      Specified by:
      getSourceTotalCost in interface IAsset

    • getSourceURL

      public String getSourceURL()
      URL to the resource within the source application, used to create a button to view this asset in the source application.
      Specified by:
      getSourceURL in interface IAsset

    • getSourceUpdatedAt

      public Long getSourceUpdatedAt()
      Time (epoch) at which this asset was last updated in the source system, in milliseconds.
      Specified by:
      getSourceUpdatedAt in interface IAsset

    • getSourceUpdatedBy

      public String getSourceUpdatedBy()
      Name of the user who last updated this asset, in the source system.
      Specified by:
      getSourceUpdatedBy in interface IAsset

    • getStarredBy

      public SortedSet<String> getStarredBy()
      Users who have starred this asset.
      Specified by:
      getStarredBy in interface IAsset

    • getStarredCount

      public Integer getStarredCount()
      Number of users who have starred this asset.
      Specified by:
      getStarredCount in interface IAsset

    • getStarredDetails

      public List<StarredDetails> getStarredDetails()
      List of usernames with extra information of the users who have starred an asset.
      Specified by:
      getStarredDetails in interface IAsset

    • getSubType

      public String getSubType()
      Subtype of this asset.
      Specified by:
      getSubType in interface IAsset

    • getTenantId

      public String getTenantId()
      Name of the Atlan workspace in which this asset exists.
      Specified by:
      getTenantId in interface IAsset

    • getUserDefRelationshipFroms

      public SortedSet<IAsset> getUserDefRelationshipFroms()
      TBC
      Specified by:
      getUserDefRelationshipFroms in interface IAsset

    • getUserDefRelationshipTos

      public SortedSet<IAsset> getUserDefRelationshipTos()
      TBC
      Specified by:
      getUserDefRelationshipTos in interface IAsset

    • getUserDescription

      public String getUserDescription()
      Description of this asset, as provided by a user. If present, this will be used for the description in user interface.
      Specified by:
      getUserDescription in interface IAsset

    • getViewScore

      public Double getViewScore()
      View score for this asset.
      Specified by:
      getViewScore in interface IAsset

    • getViewerGroups

      public SortedSet<String> getViewerGroups()
      List of groups who can view assets contained in a collection. (This is only used for certain asset types.)
      Specified by:
      getViewerGroups in interface IAsset

    • getViewerUsers

      public SortedSet<String> getViewerUsers()
      List of users who can view assets contained in a collection. (This is only used for certain asset types.)
      Specified by:
      getViewerUsers in interface IAsset

    • getAtlanTags

      public SortedSet<AtlanTag> getAtlanTags()
      Atlan tags assigned to the asset.
      Specified by:
      getAtlanTags in interface IReferenceable

    • getCustomMetadataSets

      public Map<String,CustomMetadataAttributes> 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:
      getCustomMetadataSets in interface IReferenceable

    • getStatus

      public AtlanStatus getStatus()
      Status of the asset.
      Specified by:
      getStatus in interface IReferenceable

    • getCreatedBy

      public String getCreatedBy()
      User or account that created the asset.
      Specified by:
      getCreatedBy in interface IReferenceable

    • getUpdatedBy

      public String getUpdatedBy()
      User or account that last updated the asset.
      Specified by:
      getUpdatedBy in interface IReferenceable

    • getCreateTime

      public Long getCreateTime()
      Time (epoch) at which the asset was created, in milliseconds.
      Specified by:
      getCreateTime in interface IReferenceable

    • getUpdateTime

      public Long getUpdateTime()
      Time (epoch) at which the asset was last updated, in milliseconds.
      Specified by:
      getUpdateTime in interface IReferenceable

    • getDeleteHandler

      public String getDeleteHandler()
      Details on the handler used for deletion of the asset.
      Specified by:
      getDeleteHandler in interface IReferenceable

    • getDepth

      public Long 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

      public List<LineageRef> 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 when immediateNeighbors is true, and could vary even for the same asset depending on the starting point and depth of the lineage requested.

    • getImmediateDownstream

      public List<LineageRef> 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 when immediateNeighbors is true, and could vary even for the same asset depending on the starting point and depth of the lineage requested.

    • getAtlanTagNames

      @Deprecated public SortedSet<String> 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:
      getAtlanTagNames in interface IReferenceable
      See Also:
      • atlanTags

    • getIsIncomplete

      public Boolean getIsIncomplete()
      Unused.
      Specified by:
      getIsIncomplete in interface IReferenceable

    • getMeaningNames

      public SortedSet<String> getMeaningNames()
      Names of terms that have been linked to this asset.
      Specified by:
      getMeaningNames in interface IReferenceable

    • getMeanings

      @Deprecated public SortedSet<Meaning> getMeanings()
      Deprecated.
      see assignedTerms instead
      Details 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:
      getMeanings in interface IReferenceable

    • getPendingTasks

      public SortedSet<String> getPendingTasks()
      Unique identifiers (GUIDs) for any background tasks that are yet to operate on this asset.
      Specified by:
      getPendingTasks in interface IReferenceable

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Reference

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Reference

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Reference

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class Reference