Crawler (AWS Java SDK for AWS Glue 1.11.333 API)

java.lang.Object
- com.amazonaws.services.glue.model.Crawler

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Crawler
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Crawler()

Constructors
Constructor and Description
`Crawler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Crawler`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getClassifiers()` A list of custom classifiers associated with the crawler.
`String`	`getConfiguration()` Crawler configuration information.
`Long`	`getCrawlElapsedTime()` If the crawler is running, contains the total time elapsed since the last crawl began.
`Date`	`getCreationTime()` The time when the crawler was created.
`String`	`getDatabaseName()` The database where metadata is written by this crawler.
`String`	`getDescription()` A description of the crawler.
`LastCrawlInfo`	`getLastCrawl()` The status of the last crawl, and potentially error information if an error occurred.
`Date`	`getLastUpdated()` The time the crawler was last updated.
`String`	`getName()` The crawler name.
`String`	`getRole()` The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
`Schedule`	`getSchedule()` For scheduled crawlers, the schedule when the crawler runs.
`SchemaChangePolicy`	`getSchemaChangePolicy()` Sets the behavior when the crawler finds a changed or deleted object.
`String`	`getState()` Indicates whether the crawler is running, or whether a run is pending.
`String`	`getTablePrefix()` The prefix added to the names of tables that are created.
`CrawlerTargets`	`getTargets()` A collection of targets to crawl.
`Long`	`getVersion()` The version of the crawler.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setClassifiers(Collection<String> classifiers)` A list of custom classifiers associated with the crawler.
`void`	`setConfiguration(String configuration)` Crawler configuration information.
`void`	`setCrawlElapsedTime(Long crawlElapsedTime)` If the crawler is running, contains the total time elapsed since the last crawl began.
`void`	`setCreationTime(Date creationTime)` The time when the crawler was created.
`void`	`setDatabaseName(String databaseName)` The database where metadata is written by this crawler.
`void`	`setDescription(String description)` A description of the crawler.
`void`	`setLastCrawl(LastCrawlInfo lastCrawl)` The status of the last crawl, and potentially error information if an error occurred.
`void`	`setLastUpdated(Date lastUpdated)` The time the crawler was last updated.
`void`	`setName(String name)` The crawler name.
`void`	`setRole(String role)` The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
`void`	`setSchedule(Schedule schedule)` For scheduled crawlers, the schedule when the crawler runs.
`void`	`setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` Sets the behavior when the crawler finds a changed or deleted object.
`void`	`setState(String state)` Indicates whether the crawler is running, or whether a run is pending.
`void`	`setTablePrefix(String tablePrefix)` The prefix added to the names of tables that are created.
`void`	`setTargets(CrawlerTargets targets)` A collection of targets to crawl.
`void`	`setVersion(Long version)` The version of the crawler.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Crawler`	`withClassifiers(Collection<String> classifiers)` A list of custom classifiers associated with the crawler.
`Crawler`	`withClassifiers(String... classifiers)` A list of custom classifiers associated with the crawler.
`Crawler`	`withConfiguration(String configuration)` Crawler configuration information.
`Crawler`	`withCrawlElapsedTime(Long crawlElapsedTime)` If the crawler is running, contains the total time elapsed since the last crawl began.
`Crawler`	`withCreationTime(Date creationTime)` The time when the crawler was created.
`Crawler`	`withDatabaseName(String databaseName)` The database where metadata is written by this crawler.
`Crawler`	`withDescription(String description)` A description of the crawler.
`Crawler`	`withLastCrawl(LastCrawlInfo lastCrawl)` The status of the last crawl, and potentially error information if an error occurred.
`Crawler`	`withLastUpdated(Date lastUpdated)` The time the crawler was last updated.
`Crawler`	`withName(String name)` The crawler name.
`Crawler`	`withRole(String role)` The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
`Crawler`	`withSchedule(Schedule schedule)` For scheduled crawlers, the schedule when the crawler runs.
`Crawler`	`withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` Sets the behavior when the crawler finds a changed or deleted object.
`Crawler`	`withState(CrawlerState state)` Indicates whether the crawler is running, or whether a run is pending.
`Crawler`	`withState(String state)` Indicates whether the crawler is running, or whether a run is pending.
`Crawler`	`withTablePrefix(String tablePrefix)` The prefix added to the names of tables that are created.
`Crawler`	`withTargets(CrawlerTargets targets)` A collection of targets to crawl.
`Crawler`	`withVersion(Long version)` The version of the crawler.

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

- Constructor Detail
  - Crawler
```
public Crawler()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The crawler name.
    
    Parameters:
    
    name - The crawler name.
  - getName
```
public String getName()
```
    The crawler name.
    
    Returns:
    
    The crawler name.
  - withName
```
public Crawler withName(String name)
```
    The crawler name.
    
    Parameters:
    
    name - The crawler name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
    
    Parameters:
    
    role - The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
  - getRole
```
public String getRole()
```
    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.
  - withRole
```
public Crawler withRole(String role)
```
    The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
    
    Parameters:
    
    role - The IAM role (or ARN of an IAM role) used to access customer resources, such as data in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargets
```
public void setTargets(CrawlerTargets targets)
```
    A collection of targets to crawl.
    
    Parameters:
    
    targets - A collection of targets to crawl.
  - getTargets
```
public CrawlerTargets getTargets()
```
    A collection of targets to crawl.
    
    Returns:
    
    A collection of targets to crawl.
  - withTargets
```
public Crawler withTargets(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.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The database where metadata is written by this crawler.
    
    Parameters:
    
    databaseName - The database where metadata is written by this crawler.
  - getDatabaseName
```
public String getDatabaseName()
```
    The database where metadata is written by this crawler.
    
    Returns:
    
    The database where metadata is written by this crawler.
  - withDatabaseName
```
public Crawler withDatabaseName(String databaseName)
```
    The database where metadata is written by this crawler.
    
    Parameters:
    
    databaseName - The database where metadata is written by this crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the crawler.
    
    Parameters:
    
    description - A description of the crawler.
  - getDescription
```
public String getDescription()
```
    A description of the crawler.
    
    Returns:
    
    A description of the crawler.
  - withDescription
```
public Crawler withDescription(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.
  - getClassifiers
```
public List<String> getClassifiers()
```
    A list of custom classifiers associated with the crawler.
    
    Returns:
    
    A list of custom classifiers associated with the crawler.
  - setClassifiers
```
public void setClassifiers(Collection<String> classifiers)
```
    A list of custom classifiers associated with the crawler.
    
    Parameters:
    
    classifiers - A list of custom classifiers associated with the crawler.
  - withClassifiers
```
public Crawler withClassifiers(String... classifiers)
```
    A list of custom classifiers associated with the crawler.
    
    NOTE: This method appends the values to the existing list (if any). Use setClassifiers(java.util.Collection) or withClassifiers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    classifiers - A list of custom classifiers associated with the crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withClassifiers
```
public Crawler withClassifiers(Collection<String> classifiers)
```
    A list of custom classifiers associated with the crawler.
    
    Parameters:
    
    classifiers - A list of custom classifiers associated with the crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaChangePolicy
```
public void setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    Sets the behavior when the crawler finds a changed or deleted object.
    
    Parameters:
    
    schemaChangePolicy - Sets the behavior when the crawler finds a changed or deleted object.
  - getSchemaChangePolicy
```
public SchemaChangePolicy getSchemaChangePolicy()
```
    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.
  - withSchemaChangePolicy
```
public Crawler withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    Sets the behavior when the crawler finds a changed or deleted object.
    
    Parameters:
    
    schemaChangePolicy - Sets the behavior when the crawler finds a changed or deleted object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(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.
    
    See Also:
    
    CrawlerState
  - getState
```
public String getState()
```
    Indicates whether the crawler is running, or whether a run is pending.
    
    Returns:
    
    Indicates whether the crawler is running, or whether a run is pending.
    
    See Also:
    
    CrawlerState
  - withState
```
public Crawler withState(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
  - withState
```
public Crawler withState(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
  - setTablePrefix
```
public void setTablePrefix(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.
  - getTablePrefix
```
public String getTablePrefix()
```
    The prefix added to the names of tables that are created.
    
    Returns:
    
    The prefix added to the names of tables that are created.
  - withTablePrefix
```
public Crawler withTablePrefix(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.
  - setSchedule
```
public void setSchedule(Schedule schedule)
```
    For scheduled crawlers, the schedule when the crawler runs.
    
    Parameters:
    
    schedule - For scheduled crawlers, the schedule when the crawler runs.
  - getSchedule
```
public Schedule getSchedule()
```
    For scheduled crawlers, the schedule when the crawler runs.
    
    Returns:
    
    For scheduled crawlers, the schedule when the crawler runs.
  - withSchedule
```
public Crawler withSchedule(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.
  - setCrawlElapsedTime
```
public void setCrawlElapsedTime(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.
  - getCrawlElapsedTime
```
public Long getCrawlElapsedTime()
```
    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.
  - withCrawlElapsedTime
```
public Crawler withCrawlElapsedTime(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.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time when the crawler was created.
    
    Parameters:
    
    creationTime - The time when the crawler was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time when the crawler was created.
    
    Returns:
    
    The time when the crawler was created.
  - withCreationTime
```
public Crawler withCreationTime(Date creationTime)
```
    The time when the crawler was created.
    
    Parameters:
    
    creationTime - The time when the crawler was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdated
```
public void setLastUpdated(Date lastUpdated)
```
    The time the crawler was last updated.
    
    Parameters:
    
    lastUpdated - The time the crawler was last updated.
  - getLastUpdated
```
public Date getLastUpdated()
```
    The time the crawler was last updated.
    
    Returns:
    
    The time the crawler was last updated.
  - withLastUpdated
```
public Crawler withLastUpdated(Date lastUpdated)
```
    The time the crawler was last updated.
    
    Parameters:
    
    lastUpdated - The time the crawler was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastCrawl
```
public void setLastCrawl(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.
  - getLastCrawl
```
public LastCrawlInfo getLastCrawl()
```
    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.
  - withLastCrawl
```
public Crawler withLastCrawl(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.
  - setVersion
```
public void setVersion(Long version)
```
    The version of the crawler.
    
    Parameters:
    
    version - The version of the crawler.
  - getVersion
```
public Long getVersion()
```
    The version of the crawler.
    
    Returns:
    
    The version of the crawler.
  - withVersion
```
public Crawler withVersion(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.
  - setConfiguration
```
public void setConfiguration(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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
    
    Parameters:
    
    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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
  - getConfiguration
```
public String getConfiguration()
```
    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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
    
    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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
  - withConfiguration
```
public Crawler withConfiguration(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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
    
    Parameters:
    
    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:
    
    Example: '{ "Version": 1.0, "CrawlerOutput": { "Partitions": { "AddOrUpdateBehavior": "InheritFromTable" } } }'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Crawler clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Crawler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Crawler

Method Detail

setName

getName

withName

setRole

getRole

withRole

setTargets

getTargets

withTargets

setDatabaseName

getDatabaseName

withDatabaseName

setDescription

getDescription

withDescription

getClassifiers

setClassifiers

withClassifiers

withClassifiers

setSchemaChangePolicy

getSchemaChangePolicy

withSchemaChangePolicy

setState

getState

withState

withState

setTablePrefix

getTablePrefix

withTablePrefix

setSchedule

getSchedule

withSchedule

setCrawlElapsedTime

getCrawlElapsedTime

withCrawlElapsedTime

setCreationTime

getCreationTime

withCreationTime

setLastUpdated

getLastUpdated

withLastUpdated

setLastCrawl

getLastCrawl

withLastCrawl

setVersion

getVersion

withVersion

setConfiguration

getConfiguration

withConfiguration

toString

equals

hashCode

clone

marshall