Crawler (AWS SDK for Java - 2.0.0-preview-10)

java.lang.Object
- software.amazon.awssdk.services.glue.model.Crawler

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Crawler.Builder,Crawler>
```
@Generated(value="software.amazon.awssdk:codegen")
public class Crawler
extends Object
implements StructuredPojo, ToCopyableBuilder<Crawler.Builder,Crawler>
```
Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Crawler.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Crawler.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Crawler.Builder`	`builder()`
`List<String>`	`classifiers()` A list of custom classifiers associated with the crawler.
`String`	`configuration()` Crawler configuration information.
`Long`	`crawlElapsedTime()` If the crawler is running, contains the total time elapsed since the last crawl began.
`Instant`	`creationTime()` The time when the crawler was created.
`String`	`databaseName()` The database where metadata is written by this crawler.
`String`	`description()` A description of the crawler.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LastCrawlInfo`	`lastCrawl()` The status of the last crawl, and potentially error information if an error occurred.
`Instant`	`lastUpdated()` The time the crawler was last updated.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`name()` The crawler name.
`String`	`role()` The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
`Schedule`	`schedule()` For scheduled crawlers, the schedule when the crawler runs.
`SchemaChangePolicy`	`schemaChangePolicy()` Sets the behavior when the crawler finds a changed or deleted object.
`static Class<? extends Crawler.Builder>`	`serializableBuilderClass()`
`CrawlerState`	`state()` Indicates whether the crawler is running, or whether a run is pending.
`String`	`stateAsString()` Indicates whether the crawler is running, or whether a run is pending.
`String`	`tablePrefix()` The prefix added to the names of tables that are created.
`CrawlerTargets`	`targets()` A collection of targets to crawl.
`Crawler.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Long`	`version()` The version of the crawler.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    The crawler name.
    
    Returns:
    
    The crawler name.
  - role
```
public String role()
```
    The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
    
    Returns:
    
    The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
  - targets
```
public CrawlerTargets targets()
```
    A collection of targets to crawl.
    
    Returns:
    
    A collection of targets to crawl.
  - databaseName
```
public String databaseName()
```
    The database where metadata is written by this crawler.
    
    Returns:
    
    The database where metadata is written by this crawler.
  - description
```
public String description()
```
    A description of the crawler.
    
    Returns:
    
    A description of the crawler.
  - classifiers
```
public List<String> classifiers()
```
    A list of custom classifiers associated with the crawler.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of custom classifiers associated with the crawler.
  - schemaChangePolicy
```
public SchemaChangePolicy schemaChangePolicy()
```
    Sets the behavior when the crawler finds a changed or deleted object.
    
    Returns:
    
    Sets the behavior when the crawler finds a changed or deleted object.
  - state
```
public CrawlerState state()
```
    Indicates whether the crawler is running, or whether a run is pending.
    
    If the service returns an enum value that is not available in the current SDK version, state will return CrawlerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Indicates whether the crawler is running, or whether a run is pending.
    
    See Also:
    
    CrawlerState
  - stateAsString
```
public String stateAsString()
```
    Indicates whether the crawler is running, or whether a run is pending.
    
    If the service returns an enum value that is not available in the current SDK version, state will return CrawlerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    Indicates whether the crawler is running, or whether a run is pending.
    
    See Also:
    
    CrawlerState
  - tablePrefix
```
public String tablePrefix()
```
    The prefix added to the names of tables that are created.
    
    Returns:
    
    The prefix added to the names of tables that are created.
  - schedule
```
public Schedule schedule()
```
    For scheduled crawlers, the schedule when the crawler runs.
    
    Returns:
    
    For scheduled crawlers, the schedule when the crawler runs.
  - crawlElapsedTime
```
public Long crawlElapsedTime()
```
    If the crawler is running, contains the total time elapsed since the last crawl began.
    
    Returns:
    
    If the crawler is running, contains the total time elapsed since the last crawl began.
  - creationTime
```
public Instant creationTime()
```
    The time when the crawler was created.
    
    Returns:
    
    The time when the crawler was created.
  - lastUpdated
```
public Instant lastUpdated()
```
    The time the crawler was last updated.
    
    Returns:
    
    The time the crawler was last updated.
  - lastCrawl
```
public LastCrawlInfo lastCrawl()
```
    The status of the last crawl, and potentially error information if an error occurred.
    
    Returns:
    
    The status of the last crawl, and potentially error information if an error occurred.
  - version
```
public Long version()
```
    The version of the crawler.
    
    Returns:
    
    The version of the crawler.
  - configuration
```
public 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:
    
    Returns:
    
    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:
  - toBuilder
```
public Crawler.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Crawler.Builder,Crawler>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Crawler.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Crawler.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Crawler

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

role

targets

databaseName

description

classifiers

schemaChangePolicy

state

stateAsString

tablePrefix

schedule

crawlElapsedTime

creationTime

lastUpdated

lastCrawl

version

configuration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall