Package com.atlan.model.packages

Class AthenaCrawler.AthenaCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<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.AthenaCrawler.AthenaCrawlerBuilder<C,B>

Enclosing class:

AthenaCrawler

public abstract static class AthenaCrawler.AthenaCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<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

Constructors

Constructor	Description
AthenaCrawlerBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
abstract C	build()
B	direct(String hostname, String workgroup, String s3Output)	Set up the crawler to extract directly from Athena.
B	exclude(String regex)	Defines a regular expression to use for excluding assets when crawling.
B	exclude(Map<String,List<String>> assets)	Defines the filter for assets to exclude when crawling.
B	iamUserAuth(String accessKey, String secretKey)	Set up the crawler to use IAM user-based authentication.
B	include(Map<String,List<String>> assets)	Defines the filter for assets to include when crawling.
protected B	metadata()	Set all the metadata for the package (labels, annotations, etc).
protected abstract B	self()
String	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AthenaCrawlerBuilder

public AthenaCrawlerBuilder()

Method Details

direct

public B direct(String hostname,
 String workgroup,
 String s3Output)

Set up the crawler to extract directly from Athena.

Parameters:

hostname - of Athena

workgroup - in Athena

s3Output - location in S3 where Athena can store query results (s3://bucket/prefix)

Returns:

the builder, set up to extract directly from Athena

iamUserAuth

public B iamUserAuth(String accessKey,
 String secretKey)

Set up the crawler to use IAM user-based authentication.

Parameters:

accessKey - through which to access Athena

secretKey - through which to access Athena

Returns:

the builder, set up to use IAM user-based authentication

include

public B include(Map<String,List<String>> assets)
          throws InvalidRequestException

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

public B exclude(Map<String,List<String>> assets)
          throws InvalidRequestException

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

public B exclude(String regex)

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

protected B metadata()

Set all the metadata for the package (labels, annotations, etc).

Specified by:

metadata in class AbstractPackage.AbstractPackageBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>

Returns:

the builder, with metadata set

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class AbstractCrawler.AbstractCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>

self

protected abstract B self()

Specified by:

self in class AbstractCrawler.AbstractCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class AbstractCrawler.AbstractCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class AbstractCrawler.AbstractCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>