com.atlan.AtlanClient Maven / Gradle / Ivy
// Generated by delombok at Thu Oct 10 18:56:32 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan;
/* Based on original code from https://github.com/stripe/stripe-java (under MIT license) */
import com.atlan.api.*;
import com.atlan.cache.*;
import com.atlan.serde.*;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.*;
import java.io.IOException;
import java.net.PasswordAuthentication;
import java.net.Proxy;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* Configuration for the SDK against a particular Atlan tenant.
*/
public class AtlanClient {
public static final String DELETED_AUDIT_OBJECT = "(DELETED)";
/**
* Timeout value that will be used for making new connections to the Atlan API (in milliseconds).
*/
private volatile int connectTimeout = Atlan.DEFAULT_CONNECT_TIMEOUT;
/**
* Timeout value that will be used for reading a response from an API request (in milliseconds).
* Note that this value should be set conservatively because some API requests can take time
* and a short timeout increases the likelihood of causing a problem in the backend.
*/
private volatile int readTimeout = Atlan.DEFAULT_READ_TIMEOUT;
/**
* Maximum number of times requests will be retried.
*/
private volatile int maxNetworkRetries = Atlan.DEFAULT_NETWORK_RETRIES;
/**
* Extra headers to include on any requests made by this client.
*/
private volatile Map> extraHeaders;
private final String apiBase;
private final boolean internalAccess;
/**
* API token to use for authenticating API calls.
*/
private volatile String apiToken;
/**
* Unique identifier (GUID) of the user this client impersonates.
*/
private volatile String userId = null;
/**
* Proxy to tunnel all Atlan connections.
*/
private volatile Proxy connectionProxy = null;
/**
* Credential for proxy authorization if required.
*/
private volatile PasswordAuthentication proxyCredential = null;
/**
* Information about your application.
*/
private volatile Map appInfo = null;
/**
* Cache of Atlan tags specific to this client.
*/
private final AtlanTagCache atlanTagCache;
/**
* Cache of custom metadata structures specific to this client.
*/
private final CustomMetadataCache customMetadataCache;
/**
* Cache of enums specific to this client.
*/
private final EnumCache enumCache;
/**
* Cache of groups specific to this client.
*/
private final GroupCache groupCache;
/**
* Cache of workspace roles specific to this client.
*/
private final RoleCache roleCache;
/**
* Cache of users specific to this client.
*/
private final UserCache userCache;
/**
* Cache of connections specific to this client.
*/
private final ConnectionCache connectionCache;
/**
* Cache of source-synced tags specific to this client.
*/
private final SourceTagCache sourceTagCache;
private final ObjectMapper mapper;
/**
* Endpoint with operations to manage type definitions.
*/
public final TypeDefsEndpoint typeDefs;
/**
* Endpoint with operations to manage workspace roles.
*/
public final RolesEndpoint roles;
/**
* Endpoint with operations to manage API tokens.
*/
public final ApiTokensEndpoint apiTokens;
/**
* Endpoint with operations to manage groups of users.
*/
public final GroupsEndpoint groups;
/**
* Endpoint with operations to manage users.
*/
public final UsersEndpoint users;
/**
* Endpoint with operations to manage workflows.
*/
public final WorkflowsEndpoint workflows;
/**
* Endpoint with operations to manage query parsing.
*/
public final QueryParserEndpoint queryParser;
/**
* Endpoint with operations to run SQL queries.
*/
public final QueriesEndpoint queries;
/**
* Endpoint with operations to manage playbooks.
*/
public final PlaybooksEndpoint playbooks;
/**
* Endpoint with operations to manage logs.
*/
public final LogsEndpoint logs;
/**
* Endpoint with operations to manage images.
*/
public final ImagesEndpoint images;
/**
* Endpoint with operations to manage files.
*/
public final FilesEndpoint files;
/**
* Endpoint with operations to manage assets.
*/
public final AssetEndpoint assets;
/**
* Endpoint with operations to manage requests.
*/
public final RequestsEndpoint requests;
/**
* Endpoint with operations to impersonate users.
*/
public final ImpersonationEndpoint impersonate;
/**
* Endpoint with operations to search details of past searches.
*/
public final SearchLogEndpoint searchLog;
/**
* Endpoint with operations to manage credentials (of connectors).
*/
public final CredentialsEndpoint credentials;
/**
* Endpoint with operations to manage background tasks.
*/
public final TaskEndpoint tasks;
/**
* Endpoint with operations to manage SSO configuration.
*/
public final SSOEndpoint sso;
/**
* Endpoint with operations to interact with OpenLineage.
*/
public final OpenLineageEndpoint openLineage;
/**
* Endpoint with operations to interact with data contracts.
*/
public final ContractsEndpoint contracts;
/**
* Client-aware asset deserializer.
*/
private final AssetDeserializer assetDeserializer;
/**
* Client-aware relationship attributes deserializer.
*/
private final RelationshipAttributesDeserializer relationshipAttributesDeserializer;
/**
* Client-aware custom metadata deserializer.
*/
private final CustomMetadataAuditDeserializer customMetadataAuditDeserializer;
/**
* Client-aware Atlan tag deserializer.
*/
private final AtlanTagDeserializer atlanTagDeserializer;
/**
* Instantiate a new client — this should only be called by the Atlan factory, hence package-private.
* @param baseURL of the tenant
*/
AtlanClient(final String baseURL) {
extraHeaders = new ConcurrentHashMap<>();
extraHeaders.putAll(Atlan.EXTRA_HEADERS);
if (baseURL.equals("INTERNAL")) {
apiBase = null;
internalAccess = true;
} else {
internalAccess = false;
if (baseURL.endsWith("/")) {
apiBase = baseURL.substring(0, baseURL.lastIndexOf("/"));
} else {
apiBase = baseURL;
}
}
mapper = Serde.createMapper(this);
typeDefs = new TypeDefsEndpoint(this);
roles = new RolesEndpoint(this);
apiTokens = new ApiTokensEndpoint(this);
groups = new GroupsEndpoint(this);
users = new UsersEndpoint(this);
workflows = new WorkflowsEndpoint(this);
queryParser = new QueryParserEndpoint(this);
queries = new QueriesEndpoint(this);
playbooks = new PlaybooksEndpoint(this);
logs = new LogsEndpoint(this);
images = new ImagesEndpoint(this);
files = new FilesEndpoint(this);
assets = new AssetEndpoint(this);
requests = new RequestsEndpoint(this);
impersonate = new ImpersonationEndpoint(this);
searchLog = new SearchLogEndpoint(this);
credentials = new CredentialsEndpoint(this);
tasks = new TaskEndpoint(this);
sso = new SSOEndpoint(this);
openLineage = new OpenLineageEndpoint(this);
contracts = new ContractsEndpoint(this);
atlanTagCache = new AtlanTagCache(typeDefs);
customMetadataCache = new CustomMetadataCache(typeDefs);
enumCache = new EnumCache(typeDefs);
groupCache = new GroupCache(groups);
roleCache = new RoleCache(roles);
userCache = new UserCache(users, apiTokens);
connectionCache = new ConnectionCache(this);
sourceTagCache = new SourceTagCache(this);
assetDeserializer = new AssetDeserializer(this);
relationshipAttributesDeserializer = new RelationshipAttributesDeserializer(this);
customMetadataAuditDeserializer = new CustomMetadataAuditDeserializer(this);
atlanTagDeserializer = new AtlanTagDeserializer(this);
}
/**
* Deserialize a string value into an object.
* @param value the value to deserialize
* @param clazz the expected object type of the deserialization
* @return the deserialized object
* @param type of the deserialized object
* @throws IOException on any errors doing the deserialization
*/
public T readValue(String value, Class clazz) throws IOException {
return mapper.readValue(value, clazz);
}
/**
* Deserialize a byte-array value into an object.
* @param value the value to deserialize
* @param clazz the expected object type of the deserialization
* @return the deserialized object
* @param type of the deserialized object
* @throws IOException on any errors doing the deserialization
*/
public T readValue(byte[] value, Class clazz) throws IOException {
return mapper.readValue(value, clazz);
}
/**
* Deserialize a string value into an object.
* @param value the value to deserialize
* @param typeRef the expected object type of the deserialization
* @return the deserialized object
* @param type of the deserialized object
* @throws IOException on any errors doing the deserialization
*/
public T readValue(String value, TypeReference typeRef) throws IOException {
return mapper.readValue(value, typeRef);
}
/**
* Converts from a JSON representation into an object.
* @param value the JSON representation
* @param typeReference the expected object type of the deserialization
* @return the deserialized object
* @param type of the deserialized object
* @throws IllegalArgumentException if conversion fails
*/
public T convertValue(JsonNode value, TypeReference typeReference) throws IllegalArgumentException {
return mapper.convertValue(value, typeReference);
}
/**
* Converts from a JSON representation into an object.
* @param value the JSON representation
* @param clazz the expected object type of the deserialization
* @return the deserialized object
* @param type of the deserialized object
* @throws IllegalArgumentException if conversion fails
*/
public T convertValue(JsonNode value, Class clazz) throws IllegalArgumentException {
return mapper.convertValue(value, clazz);
}
/**
* Serialize an object into a JSON string.
* @param value the object to serialize
* @return a string giving the JSON representing the object
* @param type of the object
* @throws IOException on any errors doing the serialization
*/
public String writeValueAsString(T value) throws IOException {
return mapper.writeValueAsString(value);
}
/**
* Serialize an object through the provided {@link JsonGenerator}.
* @param g JSON generator through which to serialize the object
* @param value object to serialize
* @throws IOException on any errors doing the serialization
*/
public void writeValue(JsonGenerator g, Object value) throws IOException {
mapper.writeValue(g, value);
}
/**
* Indicates whether the SDK is configured for cluster-internal access (true) or external access (false).
* @return boolean indicating whether the SDK is configured for cluster-internal access (true) or not (false)
*/
public boolean isInternal() {
return internalAccess;
}
/**
* Retrieve the base URL for the tenant of Atlan configured in this client.
*/
public String getBaseUrl() {
return apiBase;
}
/**
* Sets information about your application. The information is passed along to Atlan.
*
* @param name Name of your application (e.g. "MyAwesomeApp")
*/
public void setAppInfo(String name) {
setAppInfo(name, null, null, null);
}
/**
* Sets information about your application. The information is passed along to Atlan.
*
* @param name Name of your application (e.g. "MyAwesomeApp")
* @param version Version of your application (e.g. "1.2.34")
*/
public void setAppInfo(String name, String version) {
setAppInfo(name, version, null, null);
}
/**
* Sets information about your application. The information is passed along to Atlan.
*
* @param name Name of your application (e.g. "MyAwesomeApp")
* @param version Version of your application (e.g. "1.2.34")
* @param url Website for your application (e.g. "https://myawesomeapp.info")
*/
public void setAppInfo(String name, String version, String url) {
setAppInfo(name, version, url, null);
}
/**
* Sets information about your application. The information is passed along to Atlan.
*
* @param name Name of your application (e.g. "MyAwesomeApp")
* @param version Version of your application (e.g. "1.2.34")
* @param url Website for your application (e.g. "https://myawesomeapp.info")
* @param partnerId Your Atlan Partner ID (e.g. "pp_partner_1234")
*/
public void setAppInfo(String name, String version, String url, String partnerId) {
if (appInfo == null) {
appInfo = new HashMap<>();
}
appInfo.put("name", name);
appInfo.put("version", version);
appInfo.put("url", url);
appInfo.put("partner_id", partnerId);
}
/**
* Timeout value that will be used for making new connections to the Atlan API (in milliseconds).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int getConnectTimeout() {
return this.connectTimeout;
}
/**
* Timeout value that will be used for making new connections to the Atlan API (in milliseconds).
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setConnectTimeout(final int connectTimeout) {
this.connectTimeout = connectTimeout;
}
/**
* Timeout value that will be used for reading a response from an API request (in milliseconds).
* Note that this value should be set conservatively because some API requests can take time
* and a short timeout increases the likelihood of causing a problem in the backend.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int getReadTimeout() {
return this.readTimeout;
}
/**
* Timeout value that will be used for reading a response from an API request (in milliseconds).
* Note that this value should be set conservatively because some API requests can take time
* and a short timeout increases the likelihood of causing a problem in the backend.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setReadTimeout(final int readTimeout) {
this.readTimeout = readTimeout;
}
/**
* Maximum number of times requests will be retried.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int getMaxNetworkRetries() {
return this.maxNetworkRetries;
}
/**
* Maximum number of times requests will be retried.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setMaxNetworkRetries(final int maxNetworkRetries) {
this.maxNetworkRetries = maxNetworkRetries;
}
/**
* Extra headers to include on any requests made by this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map> getExtraHeaders() {
return this.extraHeaders;
}
/**
* Extra headers to include on any requests made by this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setExtraHeaders(final Map> extraHeaders) {
this.extraHeaders = extraHeaders;
}
/**
* API token to use for authenticating API calls.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getApiToken() {
return this.apiToken;
}
/**
* API token to use for authenticating API calls.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setApiToken(final String apiToken) {
this.apiToken = apiToken;
}
/**
* Unique identifier (GUID) of the user this client impersonates.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getUserId() {
return this.userId;
}
/**
* Unique identifier (GUID) of the user this client impersonates.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setUserId(final String userId) {
this.userId = userId;
}
/**
* Proxy to tunnel all Atlan connections.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Proxy getConnectionProxy() {
return this.connectionProxy;
}
/**
* Proxy to tunnel all Atlan connections.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setConnectionProxy(final Proxy connectionProxy) {
this.connectionProxy = connectionProxy;
}
/**
* Credential for proxy authorization if required.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public PasswordAuthentication getProxyCredential() {
return this.proxyCredential;
}
/**
* Credential for proxy authorization if required.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public void setProxyCredential(final PasswordAuthentication proxyCredential) {
this.proxyCredential = proxyCredential;
}
/**
* Information about your application.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getAppInfo() {
return this.appInfo;
}
/**
* Cache of Atlan tags specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AtlanTagCache getAtlanTagCache() {
return this.atlanTagCache;
}
/**
* Cache of custom metadata structures specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CustomMetadataCache getCustomMetadataCache() {
return this.customMetadataCache;
}
/**
* Cache of enums specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public EnumCache getEnumCache() {
return this.enumCache;
}
/**
* Cache of groups specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public GroupCache getGroupCache() {
return this.groupCache;
}
/**
* Cache of workspace roles specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public RoleCache getRoleCache() {
return this.roleCache;
}
/**
* Cache of users specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public UserCache getUserCache() {
return this.userCache;
}
/**
* Cache of connections specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public ConnectionCache getConnectionCache() {
return this.connectionCache;
}
/**
* Cache of source-synced tags specific to this client.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public SourceTagCache getSourceTagCache() {
return this.sourceTagCache;
}
/**
* Client-aware asset deserializer.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AssetDeserializer getAssetDeserializer() {
return this.assetDeserializer;
}
/**
* Client-aware relationship attributes deserializer.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public RelationshipAttributesDeserializer getRelationshipAttributesDeserializer() {
return this.relationshipAttributesDeserializer;
}
/**
* Client-aware custom metadata deserializer.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public CustomMetadataAuditDeserializer getCustomMetadataAuditDeserializer() {
return this.customMetadataAuditDeserializer;
}
/**
* Client-aware Atlan tag deserializer.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AtlanTagDeserializer getAtlanTagDeserializer() {
return this.atlanTagDeserializer;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy