Package com.atlan.model.packages
Class SnowflakeCrawler.SnowflakeCrawlerBuilder<C extends SnowflakeCrawler,B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C,B>>
java.lang.Object
com.atlan.model.packages.AbstractPackage.AbstractPackageBuilder<C,B>
com.atlan.model.packages.AbstractCrawler.AbstractCrawlerBuilder<C,B>
com.atlan.model.packages.SnowflakeCrawler.SnowflakeCrawlerBuilder<C,B>
- Enclosing class:
- SnowflakeCrawler
public abstract static class SnowflakeCrawler.SnowflakeCrawlerBuilder<C extends SnowflakeCrawler,B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C,B>>
extends AbstractCrawler.AbstractCrawlerBuilder<C,B>
-
Field Summary
Fields inherited from class com.atlan.model.packages.AbstractCrawler.AbstractCrawlerBuilder
client, connection, localCreds
Fields inherited from class com.atlan.model.packages.AbstractPackage.AbstractPackageBuilder
epoch
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected B
$fillValuesFrom
(C instance) accountUsage
(String hostname, String databaseName, String schemaName) Set the crawler to extract using Snowflake's account usage database and schema.Set up the crawler to use basic authentication.abstract C
build()
Defines a regular expression to use for excluding assets when crawling.Defines the filter for assets to exclude when crawling.Defines the filter for assets to include when crawling.informationSchema
(String hostname) Set the crawler to extract using Snowflake's information schema.keypairAuth
(String username, String privateKey, String privateKeyPassword, String role, String warehouse) Set up the crawler to use keypair-based authentication.lineage
(boolean include) Whether to enable lineage as part of crawling Snowflake.protected B
metadata()
Set all the metadata for the package (labels, annotations, etc).protected abstract B
self()
tags
(boolean include) Whether to enable Snowflake tag syncing as part of crawling Snowflake.toString()
Methods inherited from class com.atlan.model.packages.AbstractPackage.AbstractPackageBuilder
_annotation, _annotations, _credential, _label, _labels, _name, _parameter, _parameters, _prefix, _runName, clear_annotations, clear_labels, clear_parameters
-
Constructor Details
-
SnowflakeCrawlerBuilder
public SnowflakeCrawlerBuilder()
-
-
Method Details
-
basicAuth
Set up the crawler to use basic authentication.- Parameters:
username
- through which to access Snowflakepassword
- through which to access Snowflakerole
- name of the role within Snowflake to crawl throughwarehouse
- name of the warehouse within Snowflake to crawl through- Returns:
- the builder, set up to use basic authentication
-
keypairAuth
public B keypairAuth(String username, String privateKey, String privateKeyPassword, String role, String warehouse) Set up the crawler to use keypair-based authentication.- Parameters:
username
- through which to access SnowflakeprivateKey
- encrypted private key to for authenticating with SnowflakeprivateKeyPassword
- password for the encrypted private keyrole
- name of the role within Snowflake to crawl throughwarehouse
- name of the warehouse within Snowflake to crawl through- Returns:
- the builder, set up to use keypair-based authentication
-
informationSchema
Set the crawler to extract using Snowflake's information schema.- Parameters:
hostname
- of the Snowflake instance- Returns:
- the builder, set to extract using information schema
-
accountUsage
Set the crawler to extract using Snowflake's account usage database and schema.- Parameters:
hostname
- of the Snowflake instancedatabaseName
- name of the database to useschemaName
- name of the schema to use- Returns:
- the builder, set to extract using account usage
-
lineage
Whether to enable lineage as part of crawling Snowflake.- Parameters:
include
- if true, lineage will be included while crawling Snowflake- Returns:
- the builder, set to include or exclude lineage
-
tags
Whether to enable Snowflake tag syncing as part of crawling Snowflake.- Parameters:
include
- if true, tags in Snowflake will be included while crawling Snowflake- Returns:
- the builder, set to include or exclude Snowflake tags
-
include
Defines the filter for assets to include when crawling.- Parameters:
assets
- map keyed by database name with each value being a list of schemas- Returns:
- the builder, set to include only those assets specified
- Throws:
InvalidRequestException
- in the unlikely event the provided filter cannot be translated
-
exclude
Defines the filter for assets to exclude when crawling.- Parameters:
assets
- map keyed by database name with each value being a list of schemas- Returns:
- the builder, set to exclude only those assets specified
- Throws:
InvalidRequestException
- in the unlikely event the provided filter cannot be translated
-
exclude
Defines a regular expression to use for excluding assets when crawling.- Parameters:
regex
- any asset names that match this regular expression will be excluded from crawling- Returns:
- the builder, set to exclude any assets that match the provided regular expression
-
metadata
Set all the metadata for the package (labels, annotations, etc).- Specified by:
metadata
in classAbstractPackage.AbstractPackageBuilder<C extends SnowflakeCrawler,
B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C, B>> - Returns:
- the builder, with metadata set
-
$fillValuesFrom
- Overrides:
$fillValuesFrom
in classAbstractCrawler.AbstractCrawlerBuilder<C extends SnowflakeCrawler,
B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C, B>>
-
self
- Specified by:
self
in classAbstractCrawler.AbstractCrawlerBuilder<C extends SnowflakeCrawler,
B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C, B>>
-
build
- Specified by:
build
in classAbstractCrawler.AbstractCrawlerBuilder<C extends SnowflakeCrawler,
B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C, B>>
-
toString
- Overrides:
toString
in classAbstractCrawler.AbstractCrawlerBuilder<C extends SnowflakeCrawler,
B extends SnowflakeCrawler.SnowflakeCrawlerBuilder<C, B>>
-