Package software.amazon.awssdk.services.glue.model

Interface CreateCrawlerRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>, GlueRequest.Builder, SdkBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCrawlerRequest

public static interface CreateCrawlerRequest.Builder
extends GlueRequest.Builder, SdkPojo, CopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>

Method Summary

Modifier and Type	Method	Description
CreateCrawlerRequest.Builder	classifiers(String... classifiers)	A list of custom classifiers that the user has registered.
CreateCrawlerRequest.Builder	classifiers(Collection<String> classifiers)	A list of custom classifiers that the user has registered.
CreateCrawlerRequest.Builder	configuration(String configuration)	Crawler configuration information.
CreateCrawlerRequest.Builder	crawlerSecurityConfiguration(String crawlerSecurityConfiguration)	The name of the SecurityConfiguration structure to be used by this crawler.
CreateCrawlerRequest.Builder	databaseName(String databaseName)	The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
CreateCrawlerRequest.Builder	description(String description)	A description of the new crawler.
default CreateCrawlerRequest.Builder	lakeFormationConfiguration(Consumer<LakeFormationConfiguration.Builder> lakeFormationConfiguration)	Specifies Lake Formation configuration settings for the crawler.
CreateCrawlerRequest.Builder	lakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)	Specifies Lake Formation configuration settings for the crawler.
default CreateCrawlerRequest.Builder	lineageConfiguration(Consumer<LineageConfiguration.Builder> lineageConfiguration)	Specifies data lineage configuration settings for the crawler.
CreateCrawlerRequest.Builder	lineageConfiguration(LineageConfiguration lineageConfiguration)	Specifies data lineage configuration settings for the crawler.
CreateCrawlerRequest.Builder	name(String name)	Name of the new crawler.
CreateCrawlerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCrawlerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateCrawlerRequest.Builder	recrawlPolicy(Consumer<RecrawlPolicy.Builder> recrawlPolicy)	A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
CreateCrawlerRequest.Builder	recrawlPolicy(RecrawlPolicy recrawlPolicy)	A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
CreateCrawlerRequest.Builder	role(String role)	The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
CreateCrawlerRequest.Builder	schedule(String schedule)	A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers.
default CreateCrawlerRequest.Builder	schemaChangePolicy(Consumer<SchemaChangePolicy.Builder> schemaChangePolicy)	The policy for the crawler's update and deletion behavior.
CreateCrawlerRequest.Builder	schemaChangePolicy(SchemaChangePolicy schemaChangePolicy)	The policy for the crawler's update and deletion behavior.
CreateCrawlerRequest.Builder	tablePrefix(String tablePrefix)	The table prefix used for catalog tables that are created.
CreateCrawlerRequest.Builder	tags(Map<String,String> tags)	The tags to use with this crawler request.
default CreateCrawlerRequest.Builder	targets(Consumer<CrawlerTargets.Builder> targets)	A list of collection of targets to crawl.
CreateCrawlerRequest.Builder	targets(CrawlerTargets targets)	A list of collection of targets to crawl.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.glue.model.GlueRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

name

CreateCrawlerRequest.Builder name(String name)

Name of the new crawler.

Parameters:

name - Name of the new crawler.

Returns:

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

role

CreateCrawlerRequest.Builder role(String role)

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

Parameters:

role - The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

Returns:

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

databaseName

CreateCrawlerRequest.Builder databaseName(String databaseName)

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

Parameters:

databaseName - The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

Returns:

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

description

CreateCrawlerRequest.Builder description(String description)

A description of the new crawler.

Parameters:

description - A description of the new crawler.

Returns:

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

targets

CreateCrawlerRequest.Builder targets(CrawlerTargets targets)

A list of collection of targets to crawl.

Parameters:

targets - A list of collection of targets to crawl.

Returns:

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

targets

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

A list of collection of targets to crawl.

This is a convenience method 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)

schedule

CreateCrawlerRequest.Builder schedule(String schedule)

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

Parameters:

schedule - A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

Returns:

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

classifiers

CreateCrawlerRequest.Builder classifiers(Collection<String> classifiers)

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Parameters:

classifiers - A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Returns:

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

classifiers

CreateCrawlerRequest.Builder classifiers(String... classifiers)

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Parameters:

classifiers - A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

Returns:

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

tablePrefix

CreateCrawlerRequest.Builder tablePrefix(String tablePrefix)

The table prefix used for catalog tables that are created.

Parameters:

tablePrefix - The table prefix used for catalog tables that are created.

Returns:

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

schemaChangePolicy

CreateCrawlerRequest.Builder schemaChangePolicy(SchemaChangePolicy schemaChangePolicy)

The policy for the crawler's update and deletion behavior.

Parameters:

schemaChangePolicy - The policy for the crawler's update and deletion behavior.

Returns:

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

schemaChangePolicy

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

The policy for the crawler's update and deletion behavior.

This is a convenience method 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)

recrawlPolicy

CreateCrawlerRequest.Builder recrawlPolicy(RecrawlPolicy recrawlPolicy)

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

Parameters:

recrawlPolicy - A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

Returns:

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

recrawlPolicy

default CreateCrawlerRequest.Builder recrawlPolicy(Consumer<RecrawlPolicy.Builder> recrawlPolicy)

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

This is a convenience method that creates an instance of the RecrawlPolicy.Builder avoiding the need to create one manually via RecrawlPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recrawlPolicy(RecrawlPolicy).

Parameters:

recrawlPolicy - a consumer that will call methods on RecrawlPolicy.Builder

Returns:

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

See Also:

• recrawlPolicy(RecrawlPolicy)

lineageConfiguration

CreateCrawlerRequest.Builder lineageConfiguration(LineageConfiguration lineageConfiguration)

Specifies data lineage configuration settings for the crawler.

Parameters:

lineageConfiguration - Specifies data lineage configuration settings for the crawler.

Returns:

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

lineageConfiguration

default CreateCrawlerRequest.Builder lineageConfiguration(Consumer<LineageConfiguration.Builder> lineageConfiguration)

Specifies data lineage configuration settings for the crawler.

This is a convenience method that creates an instance of the LineageConfiguration.Builder avoiding the need to create one manually via LineageConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lineageConfiguration(LineageConfiguration).

Parameters:

lineageConfiguration - a consumer that will call methods on LineageConfiguration.Builder

Returns:

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

See Also:

• lineageConfiguration(LineageConfiguration)

lakeFormationConfiguration

CreateCrawlerRequest.Builder lakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)

Specifies Lake Formation configuration settings for the crawler.

Parameters:

lakeFormationConfiguration - Specifies Lake Formation configuration settings for the crawler.

Returns:

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

lakeFormationConfiguration

default CreateCrawlerRequest.Builder lakeFormationConfiguration(Consumer<LakeFormationConfiguration.Builder> lakeFormationConfiguration)

Specifies Lake Formation configuration settings for the crawler.

This is a convenience method that creates an instance of the LakeFormationConfiguration.Builder avoiding the need to create one manually via LakeFormationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lakeFormationConfiguration(LakeFormationConfiguration).

Parameters:

lakeFormationConfiguration - a consumer that will call methods on LakeFormationConfiguration.Builder

Returns:

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

See Also:

• lakeFormationConfiguration(LakeFormationConfiguration)

configuration

CreateCrawlerRequest.Builder configuration(String configuration)

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.

Parameters:

configuration - Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.

Returns:

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

crawlerSecurityConfiguration

CreateCrawlerRequest.Builder crawlerSecurityConfiguration(String crawlerSecurityConfiguration)

The name of the SecurityConfiguration structure to be used by this crawler.

Parameters:

crawlerSecurityConfiguration - The name of the SecurityConfiguration structure to be used by this crawler.

Returns:

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

tags

CreateCrawlerRequest.Builder tags(Map<String,String> tags)

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

Parameters:

tags - The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

Returns:

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

overrideConfiguration

CreateCrawlerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateCrawlerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.