Package com.atlan.model.packages

Class SigmaCrawler.SigmaCrawlerBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<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.SigmaCrawler.SigmaCrawlerBuilder<C,B>

Enclosing class:

SigmaCrawler

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

Method Summary

Modifier and Type	Method	Description
protected B	$fillValuesFrom(C instance)
B	apiToken(String clientId, String apiToken)	Set up the crawler to use API token-based authentication.
abstract C	build()
B	direct(String hostname)	Set up the crawler to directly extract from Sigma.
B	exclude(List<String> workbooks)	Defines the filter for assets to exclude when crawling.
B	include(List<String> workbooks)	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

SigmaCrawlerBuilder

public SigmaCrawlerBuilder()

Method Details

direct

public B direct(String hostname)

Set up the crawler to directly extract from Sigma.

Parameters:

hostname - of the Sigma host, for example aws-api.sigmacomputing.com

Returns:

the builder, set up to extract directly from Sigma

apiToken

public B apiToken(String clientId,
 String apiToken)

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

Parameters:

clientId - through which to access Sigma

apiToken - through which to access Sigma

Returns:

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

include

public B include(List<String> workbooks)
          throws InvalidRequestException

Defines the filter for assets to include when crawling.

Parameters:

workbooks - the GUIDs of workbooks to include when crawling

Returns:

the builder, set to include only those workbooks specified

Throws:

InvalidRequestException - in the unlikely event the provided filter cannot be translated

exclude

public B exclude(List<String> workbooks)
          throws InvalidRequestException

Defines the filter for assets to exclude when crawling.

Parameters:

workbooks - the GUIDs of workbooks to exclude when crawling

Returns:

the builder, set to exclude only those workbooks specified

Throws:

InvalidRequestException - in the unlikely event the provided filter cannot be translated

metadata

protected B metadata()

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

Specified by:

metadata in class AbstractPackage.AbstractPackageBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<C,B>>

Returns:

the builder, with metadata set

$fillValuesFrom

protected B $fillValuesFrom(C instance)

Overrides:

$fillValuesFrom in class AbstractCrawler.AbstractCrawlerBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<C,B>>

self

protected abstract B self()

Specified by:

self in class AbstractCrawler.AbstractCrawlerBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class AbstractCrawler.AbstractCrawlerBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<C,B>>

toString

public String toString()

Overrides:

toString in class AbstractCrawler.AbstractCrawlerBuilder<C extends SigmaCrawler,B extends SigmaCrawler.SigmaCrawlerBuilder<C,B>>