Package com.atlan.model.packages

Class ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<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.ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>

Enclosing class:

ConfluentKafkaCrawler

public abstract static class ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<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
ConfluentKafkaCrawlerBuilder()

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	apiToken(String apiKey, String apiSecret)	Set up the crawler to use API token-based authentication.
abstract C	build()
B	direct(String bootstrap, boolean encrypted)	Set up the crawler to extract directly from Kafka.
B	exclude(String regex)	Defines a regular expression to use for excluding topics when crawling.
B	include(String regex)	Defines the filter for topics to include when crawling.
protected B	metadata()	Set all the metadata for the package (labels, annotations, etc).
protected abstract B	self()
B	skipInternal(boolean enabled)	Whether to skip internal topics when crawling (true) or include them.
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

ConfluentKafkaCrawlerBuilder

public ConfluentKafkaCrawlerBuilder()

Method Details

direct

public B direct(String bootstrap,
 boolean encrypted)

Set up the crawler to extract directly from Kafka.

Parameters:

bootstrap - hostname and port number (host.example.com:9092) for the Kafka bootstrap server

encrypted - whether to use encrypted SSL connection (true), or plaintext (false)

Returns:

the builder, set up to extract directly from Kafka

apiToken

public B apiToken(String apiKey,
 String apiSecret)

Set up the crawler to use API token-based authentication.

Parameters:

apiKey - through which to access Kafka

apiSecret - through which to access Kafka

Returns:

the builder, set up to use API token-based authentication

include

public B include(String regex)
          throws InvalidRequestException

Defines the filter for topics to include when crawling.

Parameters:

regex - any topic names that match this regular expression will be included in crawling

Returns:

the builder, set to include only those topics 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 topics when crawling.

Parameters:

regex - any topic names that match this regular expression will be excluded from crawling

Returns:

the builder, set to exclude any topics that match the provided regular expression

skipInternal

public B skipInternal(boolean enabled)

Whether to skip internal topics when crawling (true) or include them.

Parameters:

enabled - if true, internal topics will be skipped when crawling

Returns:

the builder, set to include or exclude internal topics

metadata

protected B metadata()

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

Specified by:

metadata in class AbstractPackage.AbstractPackageBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>>

Returns:

the builder, with metadata set

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class AbstractCrawler.AbstractCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>>

self

protected abstract B self()

Specified by:

self in class AbstractCrawler.AbstractCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class AbstractCrawler.AbstractCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class AbstractCrawler.AbstractCrawlerBuilder<C extends ConfluentKafkaCrawler,B extends ConfluentKafkaCrawler.ConfluentKafkaCrawlerBuilder<C,B>>