Interface CreateCrawlerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCrawlerRequest.Builder,
,CreateCrawlerRequest> GlueRequest.Builder
,SdkBuilder<CreateCrawlerRequest.Builder,
,CreateCrawlerRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateCrawlerRequest
-
Method Summary
Modifier and TypeMethodDescriptionclassifiers
(String... classifiers) A list of custom classifiers that the user has registered.classifiers
(Collection<String> classifiers) A list of custom classifiers that the user has registered.configuration
(String configuration) Crawler configuration information.crawlerSecurityConfiguration
(String crawlerSecurityConfiguration) The name of theSecurityConfiguration
structure to be used by this crawler.databaseName
(String databaseName) The Glue database where results are written, such as:arn:aws:daylight:us-east-1::database/sometable/*
.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.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.lineageConfiguration
(LineageConfiguration lineageConfiguration) Specifies data lineage configuration settings for the crawler.Name of the new crawler.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.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.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.The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.Acron
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.schemaChangePolicy
(SchemaChangePolicy schemaChangePolicy) The policy for the crawler's update and deletion behavior.tablePrefix
(String tablePrefix) The table prefix used for catalog tables that are created.The tags to use with this crawler request.default CreateCrawlerRequest.Builder
targets
(Consumer<CrawlerTargets.Builder> targets) A list of collection of targets to crawl.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
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
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
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
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
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
A list of collection of targets to crawl.
This is a convenience method that creates an instance of theCrawlerTargets.Builder
avoiding the need to create one manually viaCrawlerTargets.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargets(CrawlerTargets)
.- Parameters:
targets
- a consumer that will call methods onCrawlerTargets.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
- Acron
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
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
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
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
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 theSchemaChangePolicy.Builder
avoiding the need to create one manually viaSchemaChangePolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschemaChangePolicy(SchemaChangePolicy)
.- Parameters:
schemaChangePolicy
- a consumer that will call methods onSchemaChangePolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theRecrawlPolicy.Builder
avoiding the need to create one manually viaRecrawlPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecrawlPolicy(RecrawlPolicy)
.- Parameters:
recrawlPolicy
- a consumer that will call methods onRecrawlPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theLineageConfiguration.Builder
avoiding the need to create one manually viaLineageConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolineageConfiguration(LineageConfiguration)
.- Parameters:
lineageConfiguration
- a consumer that will call methods onLineageConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theLakeFormationConfiguration.Builder
avoiding the need to create one manually viaLakeFormationConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolakeFormationConfiguration(LakeFormationConfiguration)
.- Parameters:
lakeFormationConfiguration
- a consumer that will call methods onLakeFormationConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The name of the
SecurityConfiguration
structure to be used by this crawler.- Parameters:
crawlerSecurityConfiguration
- The name of theSecurityConfiguration
structure to be used by this crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-