@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 Glue Data Catalog.
Constructor and Description |
---|
Crawler() |
Modifier and Type | Method and Description |
---|---|
Crawler |
clone() |
boolean |
equals(Object obj) |
List<String> |
getClassifiers()
A list of UTF-8 strings that specify the custom classifiers that are 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.
|
String |
getCrawlerSecurityConfiguration()
The name of the
SecurityConfiguration structure to be used by this crawler. |
Date |
getCreationTime()
The time that the crawler was created.
|
String |
getDatabaseName()
The name of the database in which the crawler's output is stored.
|
String |
getDescription()
A description of the crawler.
|
LakeFormationConfiguration |
getLakeFormationConfiguration()
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role
credentials.
|
LastCrawlInfo |
getLastCrawl()
The status of the last crawl, and potentially error information if an error occurred.
|
Date |
getLastUpdated()
The time that the crawler was last updated.
|
LineageConfiguration |
getLineageConfiguration()
A configuration that specifies whether data lineage is enabled for the crawler.
|
String |
getName()
The name of the crawler.
|
RecrawlPolicy |
getRecrawlPolicy()
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since
the last crawler run.
|
String |
getRole()
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.
|
Schedule |
getSchedule()
For scheduled crawlers, the schedule when the crawler runs.
|
SchemaChangePolicy |
getSchemaChangePolicy()
The policy that specifies update and delete behaviors for the crawler.
|
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setClassifiers(Collection<String> classifiers)
A list of UTF-8 strings that specify the custom classifiers that are 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 |
setCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)
The name of the
SecurityConfiguration structure to be used by this crawler. |
void |
setCreationTime(Date creationTime)
The time that the crawler was created.
|
void |
setDatabaseName(String databaseName)
The name of the database in which the crawler's output is stored.
|
void |
setDescription(String description)
A description of the crawler.
|
void |
setLakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role
credentials.
|
void |
setLastCrawl(LastCrawlInfo lastCrawl)
The status of the last crawl, and potentially error information if an error occurred.
|
void |
setLastUpdated(Date lastUpdated)
The time that the crawler was last updated.
|
void |
setLineageConfiguration(LineageConfiguration lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
|
void |
setName(String name)
The name of the crawler.
|
void |
setRecrawlPolicy(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.
|
void |
setRole(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.
|
void |
setSchedule(Schedule schedule)
For scheduled crawlers, the schedule when the crawler runs.
|
void |
setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
|
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.
|
Crawler |
withClassifiers(Collection<String> classifiers)
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
|
Crawler |
withClassifiers(String... classifiers)
A list of UTF-8 strings that specify the custom classifiers that are 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 |
withCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)
The name of the
SecurityConfiguration structure to be used by this crawler. |
Crawler |
withCreationTime(Date creationTime)
The time that the crawler was created.
|
Crawler |
withDatabaseName(String databaseName)
The name of the database in which the crawler's output is stored.
|
Crawler |
withDescription(String description)
A description of the crawler.
|
Crawler |
withLakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role
credentials.
|
Crawler |
withLastCrawl(LastCrawlInfo lastCrawl)
The status of the last crawl, and potentially error information if an error occurred.
|
Crawler |
withLastUpdated(Date lastUpdated)
The time that the crawler was last updated.
|
Crawler |
withLineageConfiguration(LineageConfiguration lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
|
Crawler |
withName(String name)
The name of the crawler.
|
Crawler |
withRecrawlPolicy(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 |
withRole(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.
|
Crawler |
withSchedule(Schedule schedule)
For scheduled crawlers, the schedule when the crawler runs.
|
Crawler |
withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
|
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.
|
public void setName(String name)
The name of the crawler.
name
- The name of the crawler.public String getName()
The name of the crawler.
public Crawler withName(String name)
The name of the crawler.
name
- The name of the crawler.public void setRole(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.
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.public String getRole()
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.
public Crawler withRole(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.
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.public void setTargets(CrawlerTargets targets)
A collection of targets to crawl.
targets
- A collection of targets to crawl.public CrawlerTargets getTargets()
A collection of targets to crawl.
public Crawler withTargets(CrawlerTargets targets)
A collection of targets to crawl.
targets
- A collection of targets to crawl.public void setDatabaseName(String databaseName)
The name of the database in which the crawler's output is stored.
databaseName
- The name of the database in which the crawler's output is stored.public String getDatabaseName()
The name of the database in which the crawler's output is stored.
public Crawler withDatabaseName(String databaseName)
The name of the database in which the crawler's output is stored.
databaseName
- The name of the database in which the crawler's output is stored.public void setDescription(String description)
A description of the crawler.
description
- A description of the crawler.public String getDescription()
A description of the crawler.
public Crawler withDescription(String description)
A description of the crawler.
description
- A description of the crawler.public List<String> getClassifiers()
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
public void setClassifiers(Collection<String> classifiers)
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
classifiers
- A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.public Crawler withClassifiers(String... classifiers)
A list of UTF-8 strings that specify the custom classifiers that are 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.
classifiers
- A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.public Crawler withClassifiers(Collection<String> classifiers)
A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
classifiers
- A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.public void setRecrawlPolicy(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.
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.public RecrawlPolicy getRecrawlPolicy()
A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
public Crawler withRecrawlPolicy(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.
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.public void setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
schemaChangePolicy
- The policy that specifies update and delete behaviors for the crawler.public SchemaChangePolicy getSchemaChangePolicy()
The policy that specifies update and delete behaviors for the crawler.
public Crawler withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
The policy that specifies update and delete behaviors for the crawler.
schemaChangePolicy
- The policy that specifies update and delete behaviors for the crawler.public void setLineageConfiguration(LineageConfiguration lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
lineageConfiguration
- A configuration that specifies whether data lineage is enabled for the crawler.public LineageConfiguration getLineageConfiguration()
A configuration that specifies whether data lineage is enabled for the crawler.
public Crawler withLineageConfiguration(LineageConfiguration lineageConfiguration)
A configuration that specifies whether data lineage is enabled for the crawler.
lineageConfiguration
- A configuration that specifies whether data lineage is enabled for the crawler.public void setState(String state)
Indicates whether the crawler is running, or whether a run is pending.
state
- Indicates whether the crawler is running, or whether a run is pending.CrawlerState
public String getState()
Indicates whether the crawler is running, or whether a run is pending.
CrawlerState
public Crawler withState(String state)
Indicates whether the crawler is running, or whether a run is pending.
state
- Indicates whether the crawler is running, or whether a run is pending.CrawlerState
public Crawler withState(CrawlerState state)
Indicates whether the crawler is running, or whether a run is pending.
state
- Indicates whether the crawler is running, or whether a run is pending.CrawlerState
public void setTablePrefix(String tablePrefix)
The prefix added to the names of tables that are created.
tablePrefix
- The prefix added to the names of tables that are created.public String getTablePrefix()
The prefix added to the names of tables that are created.
public Crawler withTablePrefix(String tablePrefix)
The prefix added to the names of tables that are created.
tablePrefix
- The prefix added to the names of tables that are created.public void setSchedule(Schedule schedule)
For scheduled crawlers, the schedule when the crawler runs.
schedule
- For scheduled crawlers, the schedule when the crawler runs.public Schedule getSchedule()
For scheduled crawlers, the schedule when the crawler runs.
public Crawler withSchedule(Schedule schedule)
For scheduled crawlers, the schedule when the crawler runs.
schedule
- For scheduled crawlers, the schedule when the crawler runs.public void setCrawlElapsedTime(Long crawlElapsedTime)
If the crawler is running, contains the total time elapsed since the last crawl began.
crawlElapsedTime
- If the crawler is running, contains the total time elapsed since the last crawl began.public Long getCrawlElapsedTime()
If the crawler is running, contains the total time elapsed since the last crawl began.
public Crawler withCrawlElapsedTime(Long crawlElapsedTime)
If the crawler is running, contains the total time elapsed since the last crawl began.
crawlElapsedTime
- If the crawler is running, contains the total time elapsed since the last crawl began.public void setCreationTime(Date creationTime)
The time that the crawler was created.
creationTime
- The time that the crawler was created.public Date getCreationTime()
The time that the crawler was created.
public Crawler withCreationTime(Date creationTime)
The time that the crawler was created.
creationTime
- The time that the crawler was created.public void setLastUpdated(Date lastUpdated)
The time that the crawler was last updated.
lastUpdated
- The time that the crawler was last updated.public Date getLastUpdated()
The time that the crawler was last updated.
public Crawler withLastUpdated(Date lastUpdated)
The time that the crawler was last updated.
lastUpdated
- The time that the crawler was last updated.public void setLastCrawl(LastCrawlInfo lastCrawl)
The status of the last crawl, and potentially error information if an error occurred.
lastCrawl
- The status of the last crawl, and potentially error information if an error occurred.public LastCrawlInfo getLastCrawl()
The status of the last crawl, and potentially error information if an error occurred.
public Crawler withLastCrawl(LastCrawlInfo lastCrawl)
The status of the last crawl, and potentially error information if an error occurred.
lastCrawl
- The status of the last crawl, and potentially error information if an error occurred.public void setVersion(Long version)
The version of the crawler.
version
- The version of the crawler.public Long getVersion()
The version of the crawler.
public Crawler withVersion(Long version)
The version of the crawler.
version
- The version of the crawler.public void setConfiguration(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.
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.public String getConfiguration()
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.
public Crawler withConfiguration(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.
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.public void setCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)
The name of the SecurityConfiguration
structure to be used by this crawler.
crawlerSecurityConfiguration
- The name of the SecurityConfiguration
structure to be used by this crawler.public String getCrawlerSecurityConfiguration()
The name of the SecurityConfiguration
structure to be used by this crawler.
SecurityConfiguration
structure to be used by this crawler.public Crawler withCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)
The name of the SecurityConfiguration
structure to be used by this crawler.
crawlerSecurityConfiguration
- The name of the SecurityConfiguration
structure to be used by this crawler.public void setLakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
lakeFormationConfiguration
- Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM
role credentials.public LakeFormationConfiguration getLakeFormationConfiguration()
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
public Crawler withLakeFormationConfiguration(LakeFormationConfiguration lakeFormationConfiguration)
Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM role credentials.
lakeFormationConfiguration
- Specifies whether the crawler should use Lake Formation credentials for the crawler instead of the IAM
role credentials.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.