Interface Crawler.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Crawler.Builder,Crawler>,SdkBuilder<Crawler.Builder,Crawler>,SdkPojo
- Enclosing class:
- Crawler
public static interface Crawler.Builder extends SdkPojo, CopyableBuilder<Crawler.Builder,Crawler>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Crawler.Builderclassifiers(String... classifiers)A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.Crawler.Builderclassifiers(Collection<String> classifiers)A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.Crawler.Builderconfiguration(String configuration)Crawler configuration information.Crawler.BuildercrawlElapsedTime(Long crawlElapsedTime)If the crawler is running, contains the total time elapsed since the last crawl began.Crawler.BuildercrawlerSecurityConfiguration(String crawlerSecurityConfiguration)The name of theSecurityConfigurationstructure to be used by this crawler.Crawler.BuildercreationTime(Instant creationTime)The time that the crawler was created.Crawler.BuilderdatabaseName(String databaseName)The name of the database in which the crawler's output is stored.Crawler.Builderdescription(String description)A description of the crawler.default Crawler.BuilderlakeFormationConfiguration(Consumer<LakeFormationConfiguration.Builder> lakeFormationConfiguration)Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.Crawler.BuilderlakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.default Crawler.BuilderlastCrawl(Consumer<LastCrawlInfo.Builder> lastCrawl)The status of the last crawl, and potentially error information if an error occurred.Crawler.BuilderlastCrawl(LastCrawlInfo lastCrawl)The status of the last crawl, and potentially error information if an error occurred.Crawler.BuilderlastUpdated(Instant lastUpdated)The time that the crawler was last updated.default Crawler.BuilderlineageConfiguration(Consumer<LineageConfiguration.Builder> lineageConfiguration)A configuration that specifies whether data lineage is enabled for the crawler.Crawler.BuilderlineageConfiguration(LineageConfiguration lineageConfiguration)A configuration that specifies whether data lineage is enabled for the crawler.Crawler.Buildername(String name)The name of the crawler.default Crawler.BuilderrecrawlPolicy(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.Crawler.BuilderrecrawlPolicy(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.Crawler.Builderrole(String role)The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.default Crawler.Builderschedule(Consumer<Schedule.Builder> schedule)For scheduled crawlers, the schedule when the crawler runs.Crawler.Builderschedule(Schedule schedule)For scheduled crawlers, the schedule when the crawler runs.default Crawler.BuilderschemaChangePolicy(Consumer<SchemaChangePolicy.Builder> schemaChangePolicy)The policy that specifies update and delete behaviors for the crawler.Crawler.BuilderschemaChangePolicy(SchemaChangePolicy schemaChangePolicy)The policy that specifies update and delete behaviors for the crawler.Crawler.Builderstate(String state)Indicates whether the crawler is running, or whether a run is pending.Crawler.Builderstate(CrawlerState state)Indicates whether the crawler is running, or whether a run is pending.Crawler.BuildertablePrefix(String tablePrefix)The prefix added to the names of tables that are created.default Crawler.Buildertargets(Consumer<CrawlerTargets.Builder> targets)A collection of targets to crawl.Crawler.Buildertargets(CrawlerTargets targets)A collection of targets to crawl.Crawler.Builderversion(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
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
name
Crawler.Builder name(String name)
The name of the crawler.
- Parameters:
name- The name of the crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
role
Crawler.Builder role(String role)
The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.
- Parameters:
role- The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.- 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 method that creates an instance of theCrawlerTargets.Builderavoiding the need to create one manually viaCrawlerTargets.builder().When the
Consumercompletes,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:
targets(CrawlerTargets)
-
databaseName
Crawler.Builder databaseName(String databaseName)
The name of the database in which the crawler's output is stored.
- Parameters:
databaseName- The name of the database in which the crawler's output is stored.- 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 UTF-8 strings that specify the custom classifiers that are associated with the crawler.
- Parameters:
classifiers- A list of UTF-8 strings that specify the custom classifiers that are 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 UTF-8 strings that specify the custom classifiers that are associated with the crawler.
- Parameters:
classifiers- A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recrawlPolicy
Crawler.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 Crawler.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 theRecrawlPolicy.Builderavoiding the need to create one manually viaRecrawlPolicy.builder().When the
Consumercompletes,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:
recrawlPolicy(RecrawlPolicy)
-
schemaChangePolicy
Crawler.Builder schemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
- Parameters:
schemaChangePolicy- The policy that specifies update and delete behaviors for the crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schemaChangePolicy
default Crawler.Builder schemaChangePolicy(Consumer<SchemaChangePolicy.Builder> schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
This is a convenience method that creates an instance of theSchemaChangePolicy.Builderavoiding the need to create one manually viaSchemaChangePolicy.builder().When the
Consumercompletes,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:
schemaChangePolicy(SchemaChangePolicy)
-
lineageConfiguration
Crawler.Builder lineageConfiguration(LineageConfiguration lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
- Parameters:
lineageConfiguration- A configuration that specifies whether data lineage is enabled for the crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lineageConfiguration
default Crawler.Builder lineageConfiguration(Consumer<LineageConfiguration.Builder> lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
This is a convenience method that creates an instance of theLineageConfiguration.Builderavoiding the need to create one manually viaLineageConfiguration.builder().When the
Consumercompletes,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:
lineageConfiguration(LineageConfiguration)
-
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 method that creates an instance of theSchedule.Builderavoiding the need to create one manually viaSchedule.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toschedule(Schedule).- Parameters:
schedule- a consumer that will call methods onSchedule.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 that the crawler was created.
- Parameters:
creationTime- The time that 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 that the crawler was last updated.
- Parameters:
lastUpdated- The time that 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 method that creates an instance of theLastCrawlInfo.Builderavoiding the need to create one manually viaLastCrawlInfo.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolastCrawl(LastCrawlInfo).- Parameters:
lastCrawl- a consumer that will call methods onLastCrawlInfo.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. 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
Crawler.Builder crawlerSecurityConfiguration(String crawlerSecurityConfiguration)
The name of the
SecurityConfigurationstructure to be used by this crawler.- Parameters:
crawlerSecurityConfiguration- The name of theSecurityConfigurationstructure to be used by this crawler.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lakeFormationConfiguration
Crawler.Builder lakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
- Parameters:
lakeFormationConfiguration- Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lakeFormationConfiguration
default Crawler.Builder lakeFormationConfiguration(Consumer<LakeFormationConfiguration.Builder> lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
This is a convenience method that creates an instance of theLakeFormationConfiguration.Builderavoiding the need to create one manually viaLakeFormationConfiguration.builder().When the
Consumercompletes,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:
lakeFormationConfiguration(LakeFormationConfiguration)
-
-