All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.atlan.model.packages.FivetranCrawler Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
// 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.model.packages;

import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.model.assets.Connection;
import com.atlan.model.enums.AtlanConnectorType;
import com.atlan.model.enums.AtlanPackageType;
import java.util.List;
import java.util.Map;

public class FivetranCrawler extends AbstractCrawler {
    public static final String PREFIX = AtlanPackageType.FIVETRAN.getValue();

    /**
     * Create the base configuration for a new Fivetran crawler. Sets all admins as connection admins.
     *
     * @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 Fivetran crawler
     * @throws AtlanException if there is not at least one connection admin specified, or any specified are invalid
     */
    public static FivetranCrawlerBuilder creator(AtlanClient client, String connectionName) throws AtlanException {
        return creator(client, connectionName, List.of(client.getRoleCache().getIdForName("$admin")), null, null);
    }

    /**
     * Create the base configuration for a new Fivetran 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
     * @return the builder for the base configuration of a Fivetran crawler
     * @throws AtlanException if there is not at least one connection admin specified, or any specified are invalid
     */
    public static FivetranCrawlerBuilder creator(AtlanClient client, String connectionName, List adminRoles, List adminGroups, List adminUsers) throws AtlanException {
        return _internal().setup(PREFIX, "@atlan/fivetran", client, getConnection(client, connectionName, AtlanConnectorType.FIVETRAN, adminRoles, adminGroups, adminUsers, false, false, 0L, "https://res.cloudinary.com/crunchbase-production/image/upload/c_lpad,f_auto,q_auto:eco,dpr_1/mmhosuxvz2msbiieekl3")).publishAnnouncements(false);
    }


    public static abstract class FivetranCrawlerBuilder> extends AbstractCrawlerBuilder {
        /**
         * Set up the crawler to use API token-based authentication.
         *
         * @param apiKey through which to access Fivetran APIs
         * @param apiSecret through which to access Fivetran APIs
         * @return the builder, set up to extract directly from Fivetran APIs using API token authentication
         */
        public B apiToken(String apiKey, String apiSecret) {
            String epoch = Connection.getEpochFromQualifiedName(connection.getQualifiedName());
            localCreds.name("default-fivetran-" + epoch + "-0").host("https://api.fivetran.com").port(443).authType("api").username(apiKey).password(apiSecret).connectorConfigName("atlan-connectors-fivetran");
            return this._credential(localCreds);
        }

        /**
         * Whether to publish process announcements (true) or not.
         *
         * @param enabled if true, will publish process announcements
         * @return the builder, set up to publish (or not) process announcements
         */
        public B publishAnnouncements(boolean enabled) {
            return this._parameter("advanced-config-strategy", "custom")._parameter("publish-announcements", "" + enabled);
        }

        /**
         * 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", "fivetran")._label("orchestration.atlan.com/sourceCategory", "elt")._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-hfivetran")._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-fivetran-" + epoch, "true")._label("orchestration.atlan.com/atlan-ui", "true")._annotation("orchestration.atlan.com/allowSchedule", "true")._annotation("orchestration.atlan.com/dependentPackage", "")._annotation("orchestration.atlan.com/docsUrl", "https://ask.atlan.com/hc/en-us/articles/8427123935121")._annotation("orchestration.atlan.com/emoji", "\ud83d\ude80")._annotation("orchestration.atlan.com/icon", "https://res.cloudinary.com/crunchbase-production/image/upload/c_lpad,f_auto,q_auto:eco,dpr_1/mmhosuxvz2msbiieekl3")._annotation("orchestration.atlan.com/logo", "https://alternative.me/media/256/fivetran-icon-qfxkppdpdx2oh4r9-c.png")._annotation("orchestration.atlan.com/marketplaceLink", "https://packages.atlan.com/-/web/detail/@atlan/fivetran")._annotation("orchestration.atlan.com/name", "Fivetran Enrichment")._annotation("orchestration.atlan.com/usecase", "crawling,enrichment")._annotation("package.argoproj.io/author", "Atlan")._annotation("package.argoproj.io/description", "Enrich known assets associated with Fivetran Connectors with column-level lineage.  Requires access to Fivetran\'s Metadata API.")._annotation("package.argoproj.io/homepage", "https://packages.atlan.com/-/web/detail/@atlan/fivetran")._annotation("package.argoproj.io/keywords", "[\"connector\",\"elt\",\"fivetran\",\"lineage\"]")._annotation("package.argoproj.io/name", "@atlan/fivetran")._annotation("package.argoproj.io/registry", "https://packages.atlan.com")._annotation("package.argoproj.io/repository", "git+https://github.com/atlanhq/marketplace-packages.git")._annotation("package.argoproj.io/support", "[email protected]")._annotation("orchestration.atlan.com/atlanName", PREFIX + "-default-fivetran-" + epoch)._parameters(Map.ofEntries(Map.entry("credential-guid", "{{credentialGuid}}"), Map.entry("connection", connection.toJson(client))));
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        protected B $fillValuesFrom(final C instance) {
            super.$fillValuesFrom(instance);
            FivetranCrawler.FivetranCrawlerBuilder.$fillValuesFromInstanceIntoBuilder(instance, this);
            return self();
        }

        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private static void $fillValuesFromInstanceIntoBuilder(final FivetranCrawler instance, final FivetranCrawler.FivetranCrawlerBuilder 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 "FivetranCrawler.FivetranCrawlerBuilder(super=" + super.toString() + ")";
        }
    }


    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    private static final class FivetranCrawlerBuilderImpl extends FivetranCrawler.FivetranCrawlerBuilder {
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        private FivetranCrawlerBuilderImpl() {
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        protected FivetranCrawler.FivetranCrawlerBuilderImpl self() {
            return this;
        }

        @java.lang.Override
        @java.lang.SuppressWarnings("all")
        @lombok.Generated
        public FivetranCrawler build() {
            return new FivetranCrawler(this);
        }
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    protected FivetranCrawler(final FivetranCrawler.FivetranCrawlerBuilder b) {
        super(b);
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public static FivetranCrawler.FivetranCrawlerBuilder _internal() {
        return new FivetranCrawler.FivetranCrawlerBuilderImpl();
    }

    @java.lang.SuppressWarnings("all")
    @lombok.Generated
    public FivetranCrawler.FivetranCrawlerBuilder toBuilder() {
        return new FivetranCrawler.FivetranCrawlerBuilderImpl().$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 FivetranCrawler)) return false;
        final FivetranCrawler other = (FivetranCrawler) 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 FivetranCrawler;
    }

    @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 "FivetranCrawler(super=" + super.toString() + ")";
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy