Package com.atlan

Class Atlan

java.lang.Object
com.atlan.Atlan
public abstract class Atlan extends Object
Primary point of configuration for the SDK to one or more tenants.

  • Field Details

  • Constructor Details

    • Atlan

      public Atlan()

  • Method Details

    • getClient

      public static AtlanClient getClient(String baseURL)
      Retrieve the Atlan client configured for the provided tenant URL.
      Parameters:
      baseURL - base URL of the tenant for which to configure a client

    • getClient

      public static AtlanClient getClient(String baseURL, String name)
      Retrieve the Atlan client configured for the provided tenant URL, with a given unique name. Note: generally we would advise having only a single client per tenant URL, but this method is provided for any rare case where you might want to have multiple clients against a single tenant. Note that this increases resource usage: - Information for that tenant will be cached independently in every client (increased heap) - Cache refreshes will be done independently in every client (increased latency for operations)
      Parameters:
      baseURL - base URL of the tenant for which to configure a client
      name - a unique name for this client

    • removeClient

      public static void removeClient(String baseURL, String name)
      Remove a configured Atlan client given the URL and (optional) unique name.
      Parameters:
      baseURL - base URL of the tenant for which the client is configured
      name - (optional) unique name given to the client when it was configured

    • setBaseUrl

      public static void setBaseUrl(String baseURL)
      Set the base URL for the default client. This must be called BEFORE setApiToken.
      Parameters:
      baseURL - base URL of the tenant to use as the default client
      See Also:

    • setApiToken

      public static void setApiToken(String apiToken)
      Set the API token for the default client. This can only be called AFTER setBaseUrl.
      Parameters:
      apiToken - for the default client
      See Also:

    • getDefaultClient

      public static AtlanClient getDefaultClient()
      Retrieve the default client that has been configured.
      Returns:
      the default client

    • getBaseUrl

      public static String getBaseUrl()
      Retrieve the base URL for the tenant of Atlan configured in the default client.
      Returns:
      the base URL for the tenant configured in the default client

    • getAppInfo

      public static Map<String,String> getAppInfo()
      Returns information about your application configured in the default client.
      Returns:
      information about your application configured in the default client

    • getMaxNetworkRetries

      public static int getMaxNetworkRetries()
      Returns the maximum number of times requests will be retried, as configured in the default client.
      Returns:
      the maximum number of times requests will be retried, as configured in the default client

    • setMaxNetworkRetries

      public static void setMaxNetworkRetries(int numRetries)
      Sets the maximum number of times requests will be retried, in the default client.
      Parameters:
      numRetries - the maximum number of times requests will be retried in the default client