Crawler (AWS SDK for Java

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 metatdata concerning the data source in the 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 `Classifier`s associated with this Crawler.
`Long`	`getCrawlElapsedTime()` If this 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 this Crawler's output should be stored.
`String`	`getDescription()` A description of this Crawler and where it should be used.
`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 S3.
`Schedule`	`getSchedule()` A `Schedule` object that specifies the schedule on which this Crawler is to be run.
`SchemaChangePolicy`	`getSchemaChangePolicy()` Sets policy for the crawler's update and delete behavior.
`String`	`getState()` Indicates whether this Crawler is running, or whether a run is pending.
`String`	`getTablePrefix()` The table prefix used for catalog tables created.
`CrawlerTargets`	`getTargets()` A collection of targets to crawl.
`Long`	`getVersion()` The version of the Crawler.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setClassifiers(Collection<String> classifiers)` A list of custom `Classifier`s associated with this Crawler.
`void`	`setCrawlElapsedTime(Long crawlElapsedTime)` If this 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 this Crawler's output should be stored.
`void`	`setDescription(String description)` A description of this Crawler and where it should be used.
`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 S3.
`void`	`setSchedule(Schedule schedule)` A `Schedule` object that specifies the schedule on which this Crawler is to be run.
`void`	`setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` Sets policy for the crawler's update and delete behavior.
`void`	`setState(String state)` Indicates whether this Crawler is running, or whether a run is pending.
`void`	`setTablePrefix(String tablePrefix)` The table prefix used for catalog tables 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 `Classifier`s associated with this Crawler.
`Crawler`	`withClassifiers(String... classifiers)` A list of custom `Classifier`s associated with this Crawler.
`Crawler`	`withCrawlElapsedTime(Long crawlElapsedTime)` If this 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 this Crawler's output should be stored.
`Crawler`	`withDescription(String description)` A description of this Crawler and where it should be used.
`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 S3.
`Crawler`	`withSchedule(Schedule schedule)` A `Schedule` object that specifies the schedule on which this Crawler is to be run.
`Crawler`	`withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` Sets policy for the crawler's update and delete behavior.
`Crawler`	`withState(CrawlerState state)` Indicates whether this Crawler is running, or whether a run is pending.
`Crawler`	`withState(String state)` Indicates whether this Crawler is running, or whether a run is pending.
`Crawler`	`withTablePrefix(String tablePrefix)` The table prefix used for catalog tables 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
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 S3.
    
    Parameters:
    
    role - The IAM role (or ARN of an IAM role) used to access customer resources such as data in S3.
  - getRole
```
public String getRole()
```
    The IAM role (or ARN of an IAM role) used to access customer resources such as data in S3.
    
    Returns:
    
    The IAM role (or ARN of an IAM role) used to access customer resources such as data in 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 S3.
    
    Parameters:
    
    role - The IAM role (or ARN of an IAM role) used to access customer resources such as data in 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 this Crawler's output should be stored.
    
    Parameters:
    
    databaseName - The Database where this Crawler's output should be stored.
  - getDatabaseName
```
public String getDatabaseName()
```
    The Database where this Crawler's output should be stored.
    
    Returns:
    
    The Database where this Crawler's output should be stored.
  - withDatabaseName
```
public Crawler withDatabaseName(String databaseName)
```
    The Database where this Crawler's output should be stored.
    
    Parameters:
    
    databaseName - The Database where this Crawler's output should be stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of this Crawler and where it should be used.
    
    Parameters:
    
    description - A description of this Crawler and where it should be used.
  - getDescription
```
public String getDescription()
```
    A description of this Crawler and where it should be used.
    
    Returns:
    
    A description of this Crawler and where it should be used.
  - withDescription
```
public Crawler withDescription(String description)
```
    A description of this Crawler and where it should be used.
    
    Parameters:
    
    description - A description of this Crawler and where it should be used.
    
    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 this Crawler.
    
    Returns:
    
    A list of custom Classifiers associated with this Crawler.
  - setClassifiers
```
public void setClassifiers(Collection<String> classifiers)
```
    A list of custom Classifiers associated with this Crawler.
    
    Parameters:
    
    classifiers - A list of custom Classifiers associated with this Crawler.
  - withClassifiers
```
public Crawler withClassifiers(String... classifiers)
```
    A list of custom Classifiers associated with this 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 this 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 this Crawler.
    
    Parameters:
    
    classifiers - A list of custom Classifiers associated with this Crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaChangePolicy
```
public void setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    Sets policy for the crawler's update and delete behavior.
    
    Parameters:
    
    schemaChangePolicy - Sets policy for the crawler's update and delete behavior.
  - getSchemaChangePolicy
```
public SchemaChangePolicy getSchemaChangePolicy()
```
    Sets policy for the crawler's update and delete behavior.
    
    Returns:
    
    Sets policy for the crawler's update and delete behavior.
  - withSchemaChangePolicy
```
public Crawler withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    Sets policy for the crawler's update and delete behavior.
    
    Parameters:
    
    schemaChangePolicy - Sets policy for the crawler's update and delete behavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Indicates whether this Crawler is running, or whether a run is pending.
    
    Parameters:
    
    state - Indicates whether this Crawler is running, or whether a run is pending.
    
    See Also:
    
    CrawlerState
  - getState
```
public String getState()
```
    Indicates whether this Crawler is running, or whether a run is pending.
    
    Returns:
    
    Indicates whether this Crawler is running, or whether a run is pending.
    
    See Also:
    
    CrawlerState
  - withState
```
public Crawler withState(String state)
```
    Indicates whether this Crawler is running, or whether a run is pending.
    
    Parameters:
    
    state - Indicates whether this 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 this Crawler is running, or whether a run is pending.
    
    Parameters:
    
    state - Indicates whether this 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 table prefix used for catalog tables created.
    
    Parameters:
    
    tablePrefix - The table prefix used for catalog tables created.
  - getTablePrefix
```
public String getTablePrefix()
```
    The table prefix used for catalog tables created.
    
    Returns:
    
    The table prefix used for catalog tables created.
  - withTablePrefix
```
public Crawler withTablePrefix(String tablePrefix)
```
    The table prefix used for catalog tables created.
    
    Parameters:
    
    tablePrefix - The table prefix used for catalog tables created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedule
```
public void setSchedule(Schedule schedule)
```
    A Schedule object that specifies the schedule on which this Crawler is to be run.
    
    Parameters:
    
    schedule - A Schedule object that specifies the schedule on which this Crawler is to be run.
  - getSchedule
```
public Schedule getSchedule()
```
    A Schedule object that specifies the schedule on which this Crawler is to be run.
    
    Returns:
    
    A Schedule object that specifies the schedule on which this Crawler is to be run.
  - withSchedule
```
public Crawler withSchedule(Schedule schedule)
```
    A Schedule object that specifies the schedule on which this Crawler is to be run.
    
    Parameters:
    
    schedule - A Schedule object that specifies the schedule on which this Crawler is to be run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCrawlElapsedTime
```
public void setCrawlElapsedTime(Long crawlElapsedTime)
```
    If this Crawler is running, contains the total time elapsed since the last crawl began.
    
    Parameters:
    
    crawlElapsedTime - If this Crawler is running, contains the total time elapsed since the last crawl began.
  - getCrawlElapsedTime
```
public Long getCrawlElapsedTime()
```
    If this Crawler is running, contains the total time elapsed since the last crawl began.
    
    Returns:
    
    If this Crawler is running, contains the total time elapsed since the last crawl began.
  - withCrawlElapsedTime
```
public Crawler withCrawlElapsedTime(Long crawlElapsedTime)
```
    If this Crawler is running, contains the total time elapsed since the last crawl began.
    
    Parameters:
    
    crawlElapsedTime - If this 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.
  - 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)
```
    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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall