Crawler.Builder (AWS Java SDK :: Services

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 and Description
`Crawler.Builder`	`classifiers(Collection<String> classifiers)` A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
`Crawler.Builder`	`classifiers(String... classifiers)` A list of UTF-8 strings that specify the custom classifiers that are 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`	`crawlerSecurityConfiguration(String crawlerSecurityConfiguration)` The name of the `SecurityConfiguration` structure to be used by this crawler.
`Crawler.Builder`	`creationTime(Instant creationTime)` The time that the crawler was created.
`Crawler.Builder`	`databaseName(String databaseName)` The name of the database in which the crawler's output is stored.
`Crawler.Builder`	`description(String description)` A description of the crawler.
`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.
`Crawler.Builder`	`lakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)` Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
`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 that the crawler was last updated.
`default Crawler.Builder`	`lineageConfiguration(Consumer<LineageConfiguration.Builder> lineageConfiguration)` A configuration that specifies whether data lineage is enabled for the crawler.
`Crawler.Builder`	`lineageConfiguration(LineageConfiguration lineageConfiguration)` A configuration that specifies whether data lineage is enabled for the crawler.
`Crawler.Builder`	`name(String name)` The name of the crawler.
`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.
`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.
`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.
`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)` The policy that specifies update and delete behaviors for the crawler.
`Crawler.Builder`	`schemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` The policy that specifies update and delete behaviors for the crawler.
`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.core.SdkPojo
equalsBySdkFields, sdkFields

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 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 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 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 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)
  - 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 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)
  - 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 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)
  - 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 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 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 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. 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 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.
  - 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 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)

Interface Crawler.Builder

Method Summary

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

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

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

Method Detail

name

role

targets

targets

databaseName

description

classifiers

classifiers

recrawlPolicy

recrawlPolicy

schemaChangePolicy

schemaChangePolicy

lineageConfiguration

lineageConfiguration

state

state

tablePrefix

schedule

schedule

crawlElapsedTime

creationTime

lastUpdated

lastCrawl

lastCrawl

version

configuration

crawlerSecurityConfiguration

lakeFormationConfiguration

lakeFormationConfiguration