Package com.atlan.model.core

Interface AtlanAsyncMutator

All Known Implementing Classes:
AssetDeletionResponse, AsyncCreationResponse
public interface AtlanAsyncMutator
Interface implemented by asynchronous operations to allow blocking behavior.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_ASYNC_RETRIES
    Maximum number of times to retry for async operations.

  • Method Summary

    Modifier and Type
    Method
    Description
    AssetMutationResponse
    block()
    Block until the mutating operation is confirmed to be completed.

  • Field Details

    • MAX_ASYNC_RETRIES

      static final int MAX_ASYNC_RETRIES
      Maximum number of times to retry for async operations.
      See Also:

  • Method Details

    • block

      AssetMutationResponse block() throws ApiException
      Block until the mutating operation is confirmed to be completed. Note that in most cases this will make additional API calls to confirm the mutation is complete, and therefore will add extra load and potential delays to program execution. In general, it will retry confirming the operation has completed up to the maximum defined by Atlan.getMaxNetworkRetries()
      Returns:
      the original mutation response, only after the changes are confirmed
      Throws:
      ApiException - if the retry loop is interrupted or the maximum number of retries is hit