software.amazon.awssdk.services.glue.model

Interface Crawler.Builder

All Superinterfaces:

CopyableBuilder<Crawler.Builder,Crawler>, SdkBuilder<Crawler.Builder,Crawler>

Enclosing class:

Crawler

public static interface Crawler.Builder
extends CopyableBuilder<Crawler.Builder,Crawler>

Method Summary

Modifier and Type	Method and Description
Crawler.Builder	classifiers(Collection<String> classifiers) A list of custom classifiers associated with the crawler.
Crawler.Builder	classifiers(String... classifiers) A list of custom classifiers associated with the crawler.
Crawler.Builder	configuration(String configuration) Crawler configuration information.
Crawler.Builder	crawlElapsedTime(Long crawlElapsedTime) If the crawler is running, contains the total time elapsed since the last crawl began.
Crawler.Builder	creationTime(Instant creationTime) The time when the crawler was created.
Crawler.Builder	databaseName(String databaseName) The database where metadata is written by this crawler.
Crawler.Builder	description(String description) A description of the crawler.
default Crawler.Builder	lastCrawl(Consumer<LastCrawlInfo.Builder> lastCrawl) The status of the last crawl, and potentially error information if an error occurred.
Crawler.Builder	lastCrawl(LastCrawlInfo lastCrawl) The status of the last crawl, and potentially error information if an error occurred.
Crawler.Builder	lastUpdated(Instant lastUpdated) The time the crawler was last updated.
Crawler.Builder	name(String name) The crawler name.
Crawler.Builder	role(String role) The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
default Crawler.Builder	schedule(Consumer<Schedule.Builder> schedule) For scheduled crawlers, the schedule when the crawler runs.
Crawler.Builder	schedule(Schedule schedule) For scheduled crawlers, the schedule when the crawler runs.
default Crawler.Builder	schemaChangePolicy(Consumer<SchemaChangePolicy.Builder> schemaChangePolicy) Sets the behavior when the crawler finds a changed or deleted object.
Crawler.Builder	schemaChangePolicy(SchemaChangePolicy schemaChangePolicy) Sets the behavior when the crawler finds a changed or deleted object.
Crawler.Builder	state(CrawlerState state) Indicates whether the crawler is running, or whether a run is pending.
Crawler.Builder	state(String state) Indicates whether the crawler is running, or whether a run is pending.
Crawler.Builder	tablePrefix(String tablePrefix) The prefix added to the names of tables that are created.
default Crawler.Builder	targets(Consumer<CrawlerTargets.Builder> targets) A collection of targets to crawl.
Crawler.Builder	targets(CrawlerTargets targets) A collection of targets to crawl.
Crawler.Builder	version(Long version) The version of the crawler.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

Crawler.Builder name(String name)

The crawler name.

Parameters:

name - The crawler name.

Returns:

Returns a reference to this object so that method calls can be chained together.

role

Crawler.Builder role(String role)

The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

Parameters:

role - The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

Crawler.Builder targets(CrawlerTargets targets)

A collection of targets to crawl.

Parameters:

targets - A collection of targets to crawl.

Returns:

Returns a reference to this object so that method calls can be chained together.

targets

default Crawler.Builder targets(Consumer<CrawlerTargets.Builder> targets)

A collection of targets to crawl.

This is a convenience that creates an instance of the CrawlerTargets.Builder avoiding the need to create one manually via CrawlerTargets.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targets(CrawlerTargets).

Parameters:

targets - a consumer that will call methods on CrawlerTargets.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

targets(CrawlerTargets)

databaseName

Crawler.Builder databaseName(String databaseName)

The database where metadata is written by this crawler.

Parameters:

databaseName - The database where metadata is written by this crawler.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

Crawler.Builder description(String description)

A description of the crawler.

Parameters:

description - A description of the crawler.

Returns:

Returns a reference to this object so that method calls can be chained together.

classifiers

Crawler.Builder classifiers(Collection<String> classifiers)

A list of custom classifiers associated with the crawler.

Parameters:

classifiers - A list of custom classifiers associated with the crawler.

Returns:

Returns a reference to this object so that method calls can be chained together.

classifiers

Crawler.Builder classifiers(String... classifiers)

A list of custom classifiers associated with the crawler.

Parameters:

classifiers - A list of custom classifiers associated with the crawler.

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaChangePolicy

Crawler.Builder schemaChangePolicy(SchemaChangePolicy schemaChangePolicy)

Sets the behavior when the crawler finds a changed or deleted object.

Parameters:

schemaChangePolicy - Sets the behavior when the crawler finds a changed or deleted object.

Returns:

Returns a reference to this object so that method calls can be chained together.

schemaChangePolicy

default Crawler.Builder schemaChangePolicy(Consumer<SchemaChangePolicy.Builder> schemaChangePolicy)

Sets the behavior when the crawler finds a changed or deleted object.

This is a convenience that creates an instance of the SchemaChangePolicy.Builder avoiding the need to create one manually via SchemaChangePolicy.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schemaChangePolicy(SchemaChangePolicy).

Parameters:

schemaChangePolicy - a consumer that will call methods on SchemaChangePolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schemaChangePolicy(SchemaChangePolicy)

state

Crawler.Builder state(String state)

Indicates whether the crawler is running, or whether a run is pending.

Parameters:

state - Indicates whether the crawler is running, or whether a run is pending.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CrawlerState, CrawlerState

state

Crawler.Builder state(CrawlerState state)

Indicates whether the crawler is running, or whether a run is pending.

Parameters:

state - Indicates whether the crawler is running, or whether a run is pending.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CrawlerState, CrawlerState

tablePrefix

Crawler.Builder tablePrefix(String tablePrefix)

The prefix added to the names of tables that are created.

Parameters:

tablePrefix - The prefix added to the names of tables that are created.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

Crawler.Builder schedule(Schedule schedule)

For scheduled crawlers, the schedule when the crawler runs.

Parameters:

schedule - For scheduled crawlers, the schedule when the crawler runs.

Returns:

Returns a reference to this object so that method calls can be chained together.

schedule

default Crawler.Builder schedule(Consumer<Schedule.Builder> schedule)

For scheduled crawlers, the schedule when the crawler runs.

This is a convenience that creates an instance of the Schedule.Builder avoiding the need to create one manually via Schedule.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedule(Schedule).

Parameters:

schedule - a consumer that will call methods on Schedule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

schedule(Schedule)

crawlElapsedTime

Crawler.Builder crawlElapsedTime(Long crawlElapsedTime)

If the crawler is running, contains the total time elapsed since the last crawl began.

Parameters:

crawlElapsedTime - If the crawler is running, contains the total time elapsed since the last crawl began.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationTime

Crawler.Builder creationTime(Instant creationTime)

The time when the crawler was created.

Parameters:

creationTime - The time when the crawler was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdated

Crawler.Builder lastUpdated(Instant lastUpdated)

The time the crawler was last updated.

Parameters:

lastUpdated - The time the crawler was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastCrawl

Crawler.Builder lastCrawl(LastCrawlInfo lastCrawl)

The status of the last crawl, and potentially error information if an error occurred.

Parameters:

lastCrawl - The status of the last crawl, and potentially error information if an error occurred.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastCrawl

default Crawler.Builder lastCrawl(Consumer<LastCrawlInfo.Builder> lastCrawl)

The status of the last crawl, and potentially error information if an error occurred.

This is a convenience that creates an instance of the LastCrawlInfo.Builder avoiding the need to create one manually via LastCrawlInfo.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastCrawl(LastCrawlInfo).

Parameters:

lastCrawl - a consumer that will call methods on LastCrawlInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

lastCrawl(LastCrawlInfo)

version

Crawler.Builder version(Long version)

The version of the crawler.

Parameters:

version - The version of the crawler.

Returns:

Returns a reference to this object so that method calls can be chained together.

configuration

Crawler.Builder configuration(String configuration)

Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.

You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:

Parameters:

configuration - Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.

You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:

Returns:

Returns a reference to this object so that method calls can be chained together.