Package com.atlan.model.packages

Class AthenaCrawler

java.lang.Object

com.atlan.model.packages.AbstractPackage

com.atlan.model.packages.AbstractCrawler

com.atlan.model.packages.AthenaCrawler

public class AthenaCrawler
extends AbstractCrawler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AthenaCrawler.AthenaCrawlerBuilder<C extends AthenaCrawler,B extends AthenaCrawler.AthenaCrawlerBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.packages.AbstractCrawler

AbstractCrawler.AbstractCrawlerBuilder<C extends AbstractCrawler,B extends AbstractCrawler.AbstractCrawlerBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.packages.AbstractPackage

AbstractPackage.AbstractPackageBuilder<C extends AbstractPackage,B extends AbstractPackage.AbstractPackageBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Fields inherited from class com.atlan.model.packages.AbstractPackage

_name, _prefix, _runName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AthenaCrawler(AthenaCrawler.AthenaCrawlerBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static AthenaCrawler.AthenaCrawlerBuilder<?,?>	_internal()
protected boolean	canEqual(Object other)
static AthenaCrawler.AthenaCrawlerBuilder<?,?>	creator(AtlanClient client, String connectionName)	Create the base configuration for a new Athena crawler.
static AthenaCrawler.AthenaCrawlerBuilder<?,?>	creator(AtlanClient client, String connectionName, List<String> adminRoles, List<String> adminGroups, List<String> adminUsers, boolean allowQuery, boolean allowSamples, long rowLimit)	Create the base configuration for a new Athena crawler.
boolean	equals(Object o)
int	hashCode()
AthenaCrawler.AthenaCrawlerBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.packages.AbstractCrawler

getConnection

Methods inherited from class com.atlan.model.packages.AbstractPackage

get_annotations, get_credential, get_labels, get_name, get_parameters, get_prefix, get_runName, getEpoch, toWorkflow

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

Constructor Details

AthenaCrawler

protected AthenaCrawler(AthenaCrawler.AthenaCrawlerBuilder<?,?> b)

Method Details

creator

public static AthenaCrawler.AthenaCrawlerBuilder<?,?> creator(AtlanClient client,
 String connectionName)
                                                       throws AtlanException

Create the base configuration for a new Athena crawler. Sets all admins as connection admins, allows querying and sample data previews, and a maximum limit of 10,000 rows from queries.

Parameters:

client - connectivity to an Atlan tenant

connectionName - name of the connection to create when running the crawler for the first time

Returns:

the builder for the base configuration of an Athena crawler

Throws:

AtlanException - if there is not at least one connection admin specified, or any specified are invalid

creator

public static AthenaCrawler.AthenaCrawlerBuilder<?,?> creator(AtlanClient client,
 String connectionName,
 List<String> adminRoles,
 List<String> adminGroups,
 List<String> adminUsers,
 boolean allowQuery,
 boolean allowSamples,
 long rowLimit)
                                                       throws AtlanException

Create the base configuration for a new Athena crawler.

Parameters:

client - connectivity to an Atlan tenant

connectionName - name of the connection to create when running the crawler for the first time

adminRoles - unique identifiers (GUIDs) of roles who will be connection admins on the connection

adminGroups - internal names of groups who will be connection admins on the connection

adminUsers - usernames of users who will be connection admins on the connection

allowQuery - if true, allow SQL queries against assets in the connection

allowSamples - if true, allow sample data previews for assets in the connection

rowLimit - maximum number of rows that can be returned by a SQL query for all assets in the connection

Returns:

the builder for the base configuration of an Athena crawler

Throws:

AtlanException - if there is not at least one connection admin specified, or any specified are invalid

_internal

public static AthenaCrawler.AthenaCrawlerBuilder<?,?> _internal()

toBuilder

public AthenaCrawler.AthenaCrawlerBuilder<?,?> toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCrawler

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractCrawler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCrawler

toString

public String toString()

Overrides:

toString in class AbstractCrawler