Package com.atlan.api

Class AssetEndpoint

java.lang.Object
com.atlan.api.AbstractEndpoint
com.atlan.api.AtlasEndpoint
com.atlan.api.AssetEndpoint
public class AssetEndpoint extends AtlasEndpoint
API endpoints for operating on assets.

  • Constructor Details

    • AssetEndpoint

      public AssetEndpoint(AtlanClient client)

  • Method Details

    • select

      public FluentSearch.FluentSearchBuilder<?,?> select()
      Start a fluent search that will return all assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval. Only active (non-archived) assets will be included.
      Returns:
      a fluent search that includes all assets

    • select

      public FluentSearch.FluentSearchBuilder<?,?> select(boolean includeArchived)
      Start a fluent search that will return all assets. Additional conditions can be chained onto the returned filter before any asset retrieval is attempted, ensuring all conditions are pushed-down for optimal retrieval.
      Parameters:
      includeArchived - when true, archived (soft-deleted) assets will be included
      Returns:
      a fluent search that includes all assets

    • auditLogs

      public AuditSearchResponse auditLogs(AuditSearchRequest request) throws AtlanException
      Run the requested search.
      Parameters:
      request - detailing the search query, parameters, and so on to run
      Returns:
      the results of the search
      Throws:
      AtlanException - on any API interaction problems

    • auditLogs

      public AuditSearchResponse auditLogs(AuditSearchRequest request, RequestOptions options) throws AtlanException
      Run the requested search.
      Parameters:
      request - detailing the search query, parameters, and so on to run
      options - to override default client settings
      Returns:
      the results of the search
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(Asset value) throws AtlanException
      Creates any asset, not updating any of the existing asset's Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      value - asset to upsert
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(Asset value, RequestOptions options) throws AtlanException
      Creates any asset, not updating any of the existing asset's Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      value - asset to upsert
      options - to override default client settings
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(Asset value, boolean replaceAtlanTags) throws AtlanException
      Creates any asset, optionally overwriting an existing asset's Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      value - asset to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(Asset value, boolean replaceAtlanTags, RequestOptions options) throws AtlanException
      Creates any asset, optionally overwriting an existing asset's Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      value - asset to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      options - to override default client settings
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(List<Asset> values, boolean replaceAtlanTags) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • save

      public AsyncCreationResponse save(List<Asset> values, boolean replaceAtlanTags, RequestOptions options) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and entirely ignoring any custom metadata.
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      options - to override default client settings
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • saveMergingCM

      public AsyncCreationResponse saveMergingCM(List<Asset> values, boolean replaceAtlanTags) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and merging any provided custom metadata values (but leaving any existing custom metadata values as-is).
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • saveMergingCM

      public AsyncCreationResponse saveMergingCM(List<Asset> values, boolean replaceAtlanTags, RequestOptions options) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and merging any provided custom metadata values (but leaving any existing custom metadata values as-is).
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      options - to override default client settings
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • saveReplacingCM

      public AsyncCreationResponse saveReplacingCM(List<Asset> values, boolean replaceAtlanTags) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and replacing all custom metadata values on the asset with the ones provided (wiping out any existing custom metadata on the asset that is not also provided in the request).
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • saveReplacingCM

      public AsyncCreationResponse saveReplacingCM(List<Asset> values, boolean replaceAtlanTags, RequestOptions options) throws AtlanException
      Creates any assets, optionally overwriting the existing assets' Atlan tags and replacing all custom metadata values on the asset with the ones provided (wiping out any existing custom metadata on the asset that is not also provided in the request).
      Parameters:
      values - assets to upsert
      replaceAtlanTags - whether to overwrite any existing Atlan tags (true) or not (false)
      options - to override default client settings
      Returns:
      the results of the upsert
      Throws:
      AtlanException - on any API interaction problems

    • delete

      public AssetDeletionResponse delete(String guid, AtlanDeleteType deleteType) throws AtlanException
      Deletes any asset.
      Parameters:
      guid - unique ID of the asset to delete
      deleteType - whether to soft-delete (archive) or hard-delete (purge) the asset
      Returns:
      the results of the deletion
      Throws:
      AtlanException - on any API interaction problems

    • delete

      public AssetDeletionResponse delete(List<String> guids, AtlanDeleteType deleteType) throws AtlanException
      Deletes any assets.
      Parameters:
      guids - unique IDs of the assets to delete
      deleteType - whether to soft-delete (archive) or hard-delete (purge) the assets
      Returns:
      the results of the deletion
      Throws:
      AtlanException - on any API interaction problems

    • delete

      public AssetDeletionResponse delete(List<String> guids, AtlanDeleteType deleteType, RequestOptions options) throws AtlanException
      Deletes any assets.
      Parameters:
      guids - unique IDs of the assets to delete
      deleteType - whether to soft-delete (archive) or hard-delete (purge) the assets
      options - to override default client settings
      Returns:
      the results of the deletion
      Throws:
      AtlanException - on any API interaction problems
      InvalidRequestException - if you attempt to archive a category, as categories can only be purged

    • restore

      public AssetMutationResponse restore(Asset value) throws AtlanException
      Restores any asset from a soft-deleted (archived) to an active state.
      Parameters:
      value - asset to restore
      Returns:
      the results of the restoration (the restored asset will be in the list of updated assets)
      Throws:
      AtlanException - on any API interaction problems

    • restore

      public AssetMutationResponse restore(Asset value, RequestOptions options) throws AtlanException
      Restores any asset from a soft-deleted (archived) to an active state.
      Parameters:
      value - asset to restore
      options - to override default client settings
      Returns:
      the results of the restoration (the restored asset will be in the list of updated assets)
      Throws:
      AtlanException - on any API interaction problems

    • restore

      public AssetMutationResponse restore(List<Asset> values) throws AtlanException
      Restores any assets in the list provided from a soft-deleted (archived) to active state.
      Parameters:
      values - assets to restore
      Returns:
      the results of the restoration (any restored assets will be in the list of updated assets)
      Throws:
      AtlanException - on any API interaction problems

    • restore

      public AssetMutationResponse restore(List<Asset> values, RequestOptions options) throws AtlanException
      Restores any assets in the list provided from a soft-deleted (archived) to active state.
      Parameters:
      values - assets to restore
      options - to override default client settings
      Returns:
      the results of the restoration (any restored assets will be in the list of updated assets)
      Throws:
      AtlanException - on any API interaction problems

    • get

      public AssetResponse get(String guid, boolean ignoreRelationships, boolean minExtInfo) throws AtlanException
      Retrieves any asset by its GUID.
      Parameters:
      guid - unique ID (GUID) of the asset to retrieve
      ignoreRelationships - whether to exclude the asset's relationships (true) or include them (false) in the response
      minExtInfo - TBC
      Returns:
      the requested asset and its details, if it exists
      Throws:
      AtlanException - on any API interaction problems

    • get

      public AssetResponse get(String guid, boolean ignoreRelationships, boolean minExtInfo, RequestOptions options) throws AtlanException
      Retrieves any asset by its GUID.
      Parameters:
      guid - unique ID (GUID) of the asset to retrieve
      ignoreRelationships - whether to exclude the asset's relationships (true) or include them (false) in the response
      minExtInfo - TBC
      options - to override default client settings
      Returns:
      the requested asset and its details, if it exists
      Throws:
      AtlanException - on any API interaction problems

    • updateCustomMetadataAttributes

      public void updateCustomMetadataAttributes(String guid, String cmName, CustomMetadataAttributes values) throws AtlanException
      Updates 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 for which to update the custom metadata attributes
      cmName - the name of the custom metadata to update
      values - the values of the custom metadata attributes to change
      Throws:
      AtlanException - on any API issue

    • updateCustomMetadataAttributes

      public void updateCustomMetadataAttributes(String guid, String cmName, CustomMetadataAttributes values, RequestOptions options) throws AtlanException
      Updates 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 for which to update the custom metadata attributes
      cmName - the name of the custom metadata to update
      values - the values of the custom metadata attributes to change
      options - to override default client settings
      Throws:
      AtlanException - on any API issue

    • replaceCustomMetadata

      public void replaceCustomMetadata(String guid, String cmName, CustomMetadataAttributes values) throws AtlanException
      Replaces specific custom metadata for the specified asset. This will replace everything within that named custom metadata, but not touch any of the other named custom metadata.
      Parameters:
      guid - unique identifier of the asset for which to replace the custom metadata
      cmName - the name of the custom metadata to replace
      values - the values to replace
      Throws:
      AtlanException - on any API issue

    • replaceCustomMetadata

      public void replaceCustomMetadata(String guid, String cmName, CustomMetadataAttributes values, RequestOptions options) throws AtlanException
      Replaces specific custom metadata for the specified asset. This will replace everything within that named custom metadata, but not touch any of the other named custom metadata.
      Parameters:
      guid - unique identifier of the asset for which to replace the custom metadata
      cmName - the name of the custom metadata to replace
      values - the values to replace
      options - to override the default client settings
      Throws:
      AtlanException - on any API issue

    • removeCustomMetadata

      public void removeCustomMetadata(String guid, String cmName) throws AtlanException
      Removes specific custom metadata from the specified asset.
      Parameters:
      guid - unique identifier of the asset from which to remove the custom metadata
      cmName - the name of the custom metadata to remove
      Throws:
      AtlanException - on any API issue

    • removeCustomMetadata

      public void removeCustomMetadata(String guid, String cmName, RequestOptions options) throws AtlanException
      Removes specific custom metadata from the specified asset.
      Parameters:
      guid - unique identifier of the asset from which to remove the custom metadata
      cmName - the name of the custom metadata to remove
      options - to override the default client settings
      Throws:
      AtlanException - on any API issue

    • get

      public AssetResponse get(String typeName, String qualifiedName, boolean ignoreRelationships, boolean minExtInfo) throws AtlanException
      Retrieves any asset by its qualifiedName.
      Parameters:
      typeName - type of asset to be retrieved
      qualifiedName - qualifiedName of the asset to be retrieved
      ignoreRelationships - whether to include relationships (false) or exclude them (true)
      minExtInfo - whether to minimize extra info (true) or not (false)
      Returns:
      the requested asset
      Throws:
      AtlanException - on any API issue, or if the asset cannot be found

    • get

      public AssetResponse get(String typeName, String qualifiedName, boolean ignoreRelationships, boolean minExtInfo, RequestOptions options) throws AtlanException
      Retrieves any asset by its qualifiedName.
      Parameters:
      typeName - type of asset to be retrieved
      qualifiedName - qualifiedName of the asset to be updated
      ignoreRelationships - whether to include relationships (false) or exclude them (true)
      minExtInfo - whether to minimize extra info (true) or not (false)
      options - to override the default client settings
      Returns:
      the requested asset
      Throws:
      AtlanException - on any API issue, or if the asset cannot be found

    • updateAttributes

      public AssetMutationResponse updateAttributes(String typeName, String qualifiedName, Asset value) throws AtlanException
      Updates any simple attributes provided. Note that this only supports adding or updating the values of these attributes — it is not possible to REMOVE (null) attributes through this endpoint.
      Parameters:
      typeName - type of asset to be updated
      qualifiedName - qualifiedName of the asset to be updated
      value - the asset containing only the attributes to be updated
      Returns:
      the set of changed entities
      Throws:
      AtlanException - on any API issue

    • updateAttributes

      public AssetMutationResponse updateAttributes(String typeName, String qualifiedName, Asset value, RequestOptions options) throws AtlanException
      Updates any simple attributes provided. Note that this only supports adding or updating the values of these attributes — it is not possible to REMOVE (null) attributes through this endpoint.
      Parameters:
      typeName - type of asset to be updated
      qualifiedName - qualifiedName of the asset to be updated
      value - the asset containing only the attributes to be updated
      options - to override the default client settings
      Returns:
      the set of changed entities
      Throws:
      AtlanException - on any API issue

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, RequestOptions options) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      options - to override the default client settings
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      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)
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, boolean restrictHierarchyPropagation) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      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)
      restrictHierarchyPropagation - whether to avoid propagating through hierarchy (true) or do propagate through hierarchy (false)
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, RequestOptions options) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      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)
      options - to override the default client settings
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • addAtlanTags

      public void addAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, boolean restrictHierarchyPropagation, RequestOptions options) throws AtlanException
      Add one or more Atlan tags to the provided asset. Note: if one or more of the provided Atlan tags already exists on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-01A.
      Parameters:
      typeName - type of asset to which to add the Atlan tags
      qualifiedName - of the asset to which to add the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to add to the asset
      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)
      restrictHierarchyPropagation - whether to avoid propagating through hierarchy (true) or do propagate through hierarchy (false)
      options - to override the default client settings
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • removeAtlanTag

      public void removeAtlanTag(String typeName, String qualifiedName, String atlanTagName, boolean idempotent) throws AtlanException
      Removes a single Atlan tag from the provided asset. Note: if the provided Atlan tag does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D, unless idempotent is set to true.
      Parameters:
      typeName - type of asset from which to remove the Atlan tag
      qualifiedName - of the asset from which to remove the Atlan tag
      atlanTagName - human-readable name of the Atlan tag to remove from the asset
      idempotent - whether to throw an error if the Atlan tag does not exist on the asset (false) or behave the same as if the Atlan tag was removed even though it did not exist on the asset (true)
      Throws:
      AtlanException - on any API issue, or if the Atlan tag does not exist on the asset

    • removeAtlanTag

      public void removeAtlanTag(String typeName, String qualifiedName, String atlanTagName, boolean idempotent, RequestOptions options) throws AtlanException
      Removes a single Atlan tag from the provided asset. Note: if the provided Atlan tag does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D, unless idempotent is set to true.
      Parameters:
      typeName - type of asset from which to remove the Atlan tag
      qualifiedName - of the asset from which to remove the Atlan tag
      atlanTagName - human-readable name of the Atlan tag to remove from the asset
      idempotent - whether to throw an error if the Atlan tag does not exist on the asset (false) or behave the same as if the Atlan tag was removed even though it did not exist on the asset (true)
      options - to override the default client settings
      Throws:
      AtlanException - on any API issue, or if the Atlan tag does not exist on the asset

    • updateAtlanTags

      public void updateAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation) throws AtlanException
      Update one or more Atlan tags on the provided asset. Note: if one or more of the provided Atlan tags does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D.
      Parameters:
      typeName - type of asset on which to update the Atlan tags
      qualifiedName - of the asset on which to update the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to update on the asset
      propagate - whether to propagate the Atlan tags (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)
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • updateAtlanTags

      public void updateAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, boolean restrictHierarchyPropagation) throws AtlanException
      Update one or more Atlan tags on the provided asset. Note: if one or more of the provided Atlan tags does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D.
      Parameters:
      typeName - type of asset on which to update the Atlan tags
      qualifiedName - of the asset on which to update the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to update on the asset
      propagate - whether to propagate the Atlan tags (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)
      restrictHierarchyPropagation - whether to avoid propagating through hierarchy (true) or do propagate through hierarchy (false)
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • updateAtlanTags

      public void updateAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, RequestOptions options) throws AtlanException
      Update one or more Atlan tags on the provided asset. Note: if one or more of the provided Atlan tags does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D.
      Parameters:
      typeName - type of asset on which to update the Atlan tags
      qualifiedName - of the asset on which to update the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to update on the asset
      propagate - whether to propagate the Atlan tags (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)
      options - to override the default client settings
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • updateAtlanTags

      public void updateAtlanTags(String typeName, String qualifiedName, List<String> atlanTagNames, boolean propagate, boolean removePropagationsOnDelete, boolean restrictLineagePropagation, boolean restrictHierarchyPropagation, RequestOptions options) throws AtlanException
      Update one or more Atlan tags on the provided asset. Note: if one or more of the provided Atlan tags does not exist on the asset, an InvalidRequestException will be thrown with error code ATLAS-400-00-06D.
      Parameters:
      typeName - type of asset on which to update the Atlan tags
      qualifiedName - of the asset on which to update the Atlan tags
      atlanTagNames - human-readable names of the Atlan tags to update on the asset
      propagate - whether to propagate the Atlan tags (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)
      restrictHierarchyPropagation - whether to avoid propagating through hierarchy (true) or do propagate through hierarchy (false)
      options - to override the default client settings
      Throws:
      AtlanException - on any API issues, or if any one of the Atlan tags already exists on the asset

    • search

      public IndexSearchResponse search(IndexSearchRequest request) throws AtlanException
      Run the requested search.
      Parameters:
      request - detailing the search query, parameters, and so on to run
      Returns:
      the results of the search
      Throws:
      AtlanException - on any API interaction problems

    • search

      public IndexSearchResponse search(IndexSearchRequest request, RequestOptions options) throws AtlanException
      Run the requested search.
      Parameters:
      request - detailing the search query, parameters, and so on to run
      options - to override default client settings
      Returns:
      the results of the search
      Throws:
      AtlanException - on any API interaction problems

    • lineage

      public LineageListResponse lineage(LineageListRequest request) throws AtlanException
      Retrieve lineage using the higher-performance "list" API.
      Parameters:
      request - detailing the lineage to retrieve
      Returns:
      the results of the lineage
      Throws:
      AtlanException - on any API interaction problems

    • lineage

      public LineageListResponse lineage(LineageListRequest request, RequestOptions options) throws AtlanException
      Retrieve lineage using the higher-performance "list" API.
      Parameters:
      request - detailing the lineage to retrieve
      options - to override default client settings
      Returns:
      the results of the lineage
      Throws:
      AtlanException - on any API interaction problems