com.atlan.model.packages.PostgreSQLCrawler Maven / Gradle / Ivy
// Generated by delombok at Wed Oct 16 22:16:03 UTC 2024
/* SPDX-License-Identifier: Apache-2.0
Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.model.packages;
import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.exception.ErrorCode;
import com.atlan.exception.InvalidRequestException;
import com.atlan.model.enums.AtlanConnectorType;
import com.atlan.model.enums.AtlanPackageType;
import com.atlan.serde.Serde;
import com.fasterxml.jackson.core.JsonProcessingException;
import java.util.List;
import java.util.Map;
public class PostgreSQLCrawler extends AbstractCrawler {
public static final String PREFIX = AtlanPackageType.POSTGRES.getValue();
/**
* Create the base configuration for a new PostgreSQL crawler.
* Sets all admins as connection admins, allows querying and sample data previews, and a maximum
* limit of 10,000 rows from queries.
*
* @param client connectivity to an Atlan tenant
* @param connectionName name of the connection to create when running the crawler for the first time
* @return the builder for the base configuration of a PostgreSQL crawler
* @throws AtlanException if there is not at least one connection admin specified, or any specified are invalid
*/
public static PostgreSQLCrawlerBuilder creator(AtlanClient client, String connectionName) throws AtlanException {
return creator(client, connectionName, List.of(client.getRoleCache().getIdForName("$admin")), null, null, true, true, 10000L);
}
/**
* Create the base configuration for a new PostgreSQL crawler.
*
* @param client connectivity to an Atlan tenant
* @param connectionName name of the connection to create when running the crawler for the first time
* @param adminRoles unique identifiers (GUIDs) of roles who will be connection admins on the connection
* @param adminGroups internal names of groups who will be connection admins on the connection
* @param adminUsers usernames of users who will be connection admins on the connection
* @param allowQuery if true, allow SQL queries against assets in the connection
* @param allowSamples if true, allow sample data previews for assets in the connection
* @param rowLimit maximum number of rows that can be returned by a SQL query for all assets in the connection
* @return the builder for the base configuration of a PostgreSQL crawler
* @throws AtlanException if there is not at least one connection admin specified, or any specified are invalid
*/
public static PostgreSQLCrawlerBuilder creator(AtlanClient client, String connectionName, List adminRoles, List adminGroups, List adminUsers, boolean allowQuery, boolean allowSamples, long rowLimit) throws AtlanException {
return _internal().setup(PREFIX, "@atlan/postgres", client, getConnection(client, connectionName, AtlanConnectorType.POSTGRES, adminRoles, adminGroups, adminUsers, allowQuery, allowSamples, rowLimit, "https://www.postgresql.org/media/img/about/press/elephant.png")).metadata().include(null).exclude((Map>) null);
}
public static abstract class PostgreSQLCrawlerBuilder> extends AbstractCrawlerBuilder {
/**
* Set up the crawler to extract directly from PostgreSQL.
*
* @param hostname of PostgreSQL
* @param database to extract
* @return the builder, set up to extract directly from Redshift
*/
public B direct(String hostname, String database) {
localCreds.name("default-postgres-" + epoch + "-0").host(hostname).port(5432).extra("database", database).connectorConfigName("atlan-connectors-postgres");
return this._parameter("extraction-method", "direct")._credential(localCreds);
}
/**
* Set up the crawler to use basic authentication.
*
* @param username through which to access PostgreSQL
* @param password through which to access PostgreSQL
* @return the builder, set up to use basic authentication
*/
public B basicAuth(String username, String password) {
localCreds.authType("basic").username(username).password(password);
return this._credential(localCreds);
}
/**
* Set up the crawler to use IAM user-based authentication.
*
* @param username for the IAM user
* @param accessKey through which to access PostgreSQL
* @param secretKey through which to access PostgreSQL
* @return the builder, set up to use IAM user-based authentication
*/
public B iamUserAuth(String username, String accessKey, String secretKey) {
localCreds.authType("iam").username(accessKey).password(secretKey).extra("dbuser", username);
return this._credential(localCreds);
}
/**
* Defines the filter for assets to include when crawling.
*
* @param assets map keyed by database name with each value being a list of schemas
* @return the builder, set to include only those assets specified
* @throws InvalidRequestException in the unlikely event the provided filter cannot be translated
*/
public B include(Map> assets) throws InvalidRequestException {
Map> toInclude = buildHierarchicalFilter(assets);
try {
return this._parameter("include-filter", Serde.allInclusiveMapper.writeValueAsString(toInclude));
} catch (JsonProcessingException e) {
throw new InvalidRequestException(ErrorCode.UNABLE_TO_TRANSLATE_FILTERS, e);
}
}
/**
* Defines the filter for assets to exclude when crawling.
*
* @param assets map keyed by database name with each value being a list of schemas
* @return the builder, set to exclude only those assets specified
* @throws InvalidRequestException in the unlikely event the provided filter cannot be translated
*/
public B exclude(Map> assets) throws InvalidRequestException {
Map> toExclude = buildHierarchicalFilter(assets);
try {
return this._parameter("exclude-filter", Serde.allInclusiveMapper.writeValueAsString(toExclude));
} catch (JsonProcessingException e) {
throw new InvalidRequestException(ErrorCode.UNABLE_TO_TRANSLATE_FILTERS, e);
}
}
/**
* Defines a regular expression to use for excluding assets when crawling.
*
* @param regex any asset names that match this regular expression will be excluded from crawling
* @return the builder, set to exclude any assets that match the provided regular expression
*/
public B exclude(String regex) {
return this._parameter("temp-table-regex", regex);
}
/**
* Set all the metadata for the package (labels, annotations, etc).
*
* @return the builder, with metadata set
*/
@Override
protected B metadata() {
return this._label("orchestration.atlan.com/certified", "true")._label("orchestration.atlan.com/source", "postgres")._label("orchestration.atlan.com/sourceCategory", "database")._label("orchestration.atlan.com/type", "connector")._label("orchestration.atlan.com/verified", "true")._label("package.argoproj.io/installer", "argopm")._label("package.argoproj.io/name", "a-t-ratlans-l-a-s-hpostgres")._label("package.argoproj.io/registry", "httpsc-o-l-o-ns-l-a-s-hs-l-a-s-hpackages.atlan.com")._label("orchestration.atlan.com/default-postgres-" + epoch, "true")._label("orchestration.atlan.com/atlan-ui", "true")._annotation("orchestration.atlan.com/allowSchedule", "true")._annotation("orchestration.atlan.com/categories", "postgres,crawler")._annotation("orchestration.atlan.com/dependentPackage", "")._annotation("orchestration.atlan.com/docsUrl", "https://ask.atlan.com/hc/en-us/articles/6329557275793")._annotation("orchestration.atlan.com/emoji", "\ud83d\ude80")._annotation("orchestration.atlan.com/icon", "https://www.postgresql.org/media/img/about/press/elephant.png")._annotation("orchestration.atlan.com/logo", "https://www.postgresql.org/media/img/about/press/elephant.png")._annotation("orchestration.atlan.com/marketplaceLink", "https://packages.atlan.com/-/web/detail/@atlan/postgres")._annotation("orchestration.atlan.com/name", "Postgres Assets")._annotation("package.argoproj.io/author", "Atlan")._annotation("package.argoproj.io/description", "Package to crawl PostgreSQL assets and publish to Atlan for discovery")._annotation("package.argoproj.io/homepage", "https://packages.atlan.com/-/web/detail/@atlan/postgres")._annotation("package.argoproj.io/keywords", "[\"postgres\",\"database\",\"sql\",\"connector\",\"crawler\"]")._annotation("package.argoproj.io/name", "@atlan/postgres")._annotation("package.argoproj.io/registry", "https://packages.atlan.com")._annotation("package.argoproj.io/support", "[email protected]")._annotation("orchestration.atlan.com/atlanName", PREFIX + "-default-postgres-" + epoch)._parameters(Map.ofEntries(Map.entry("credential-guid", "{{credentialGuid}}"), Map.entry("connection", connection.toJson(client)), Map.entry("publish-mode", "production")));
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected B $fillValuesFrom(final C instance) {
super.$fillValuesFrom(instance);
PostgreSQLCrawler.PostgreSQLCrawlerBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
return self();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static void $fillValuesFromInstanceIntoBuilder(final PostgreSQLCrawler instance, final PostgreSQLCrawler.PostgreSQLCrawlerBuilder b) {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected abstract B self();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "PostgreSQLCrawler.PostgreSQLCrawlerBuilder(super=" + super.toString() + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class PostgreSQLCrawlerBuilderImpl extends PostgreSQLCrawler.PostgreSQLCrawlerBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private PostgreSQLCrawlerBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected PostgreSQLCrawler.PostgreSQLCrawlerBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public PostgreSQLCrawler build() {
return new PostgreSQLCrawler(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected PostgreSQLCrawler(final PostgreSQLCrawler.PostgreSQLCrawlerBuilder b) {
super(b);
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static PostgreSQLCrawler.PostgreSQLCrawlerBuilder _internal() {
return new PostgreSQLCrawler.PostgreSQLCrawlerBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public PostgreSQLCrawler.PostgreSQLCrawlerBuilder toBuilder() {
return new PostgreSQLCrawler.PostgreSQLCrawlerBuilderImpl().$fillValuesFrom(this);
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof PostgreSQLCrawler)) return false;
final PostgreSQLCrawler other = (PostgreSQLCrawler) o;
if (!other.canEqual((java.lang.Object) this)) return false;
if (!super.equals(o)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof PostgreSQLCrawler;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int result = super.hashCode();
return result;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "PostgreSQLCrawler(super=" + super.toString() + ")";
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy