CreateCrawlerRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.glue.model.CreateCrawlerRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCrawlerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateCrawlerRequest()

Constructors
Constructor and Description
`CreateCrawlerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateCrawlerRequest`	`addTagsEntry(String key, String value)`
`CreateCrawlerRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`CreateCrawlerRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getClassifiers()` A list of custom classifiers that the user has registered.
`String`	`getConfiguration()` The crawler configuration information.
`String`	`getCrawlerSecurityConfiguration()` The name of the `SecurityConfiguration` structure to be used by this crawler.
`String`	`getDatabaseName()` The AWS Glue database where results are written, such as: `arn:aws:daylight:us-east-1::database/sometable/*`.
`String`	`getDescription()` A description of the new crawler.
`String`	`getName()` Name of the new crawler.
`String`	`getRole()` The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
`String`	`getSchedule()` A `cron` expression used to specify the schedule.
`SchemaChangePolicy`	`getSchemaChangePolicy()` The policy for the crawler's update and deletion behavior.
`String`	`getTablePrefix()` The table prefix used for catalog tables that are created.
`Map<String,String>`	`getTags()` The tags to use with this crawler request.
`CrawlerTargets`	`getTargets()` A list of collection of targets to crawl.
`int`	`hashCode()`
`void`	`setClassifiers(Collection<String> classifiers)` A list of custom classifiers that the user has registered.
`void`	`setConfiguration(String configuration)` The crawler configuration information.
`void`	`setCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)` The name of the `SecurityConfiguration` structure to be used by this crawler.
`void`	`setDatabaseName(String databaseName)` The AWS Glue database where results are written, such as: `arn:aws:daylight:us-east-1::database/sometable/*`.
`void`	`setDescription(String description)` A description of the new crawler.
`void`	`setName(String name)` Name of the new crawler.
`void`	`setRole(String role)` The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
`void`	`setSchedule(String schedule)` A `cron` expression used to specify the schedule.
`void`	`setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` The policy for the crawler's update and deletion behavior.
`void`	`setTablePrefix(String tablePrefix)` The table prefix used for catalog tables that are created.
`void`	`setTags(Map<String,String> tags)` The tags to use with this crawler request.
`void`	`setTargets(CrawlerTargets targets)` A list of collection of targets to crawl.
`String`	`toString()` Returns a string representation of this object.
`CreateCrawlerRequest`	`withClassifiers(Collection<String> classifiers)` A list of custom classifiers that the user has registered.
`CreateCrawlerRequest`	`withClassifiers(String... classifiers)` A list of custom classifiers that the user has registered.
`CreateCrawlerRequest`	`withConfiguration(String configuration)` The crawler configuration information.
`CreateCrawlerRequest`	`withCrawlerSecurityConfiguration(String crawlerSecurityConfiguration)` The name of the `SecurityConfiguration` structure to be used by this crawler.
`CreateCrawlerRequest`	`withDatabaseName(String databaseName)` The AWS Glue database where results are written, such as: `arn:aws:daylight:us-east-1::database/sometable/*`.
`CreateCrawlerRequest`	`withDescription(String description)` A description of the new crawler.
`CreateCrawlerRequest`	`withName(String name)` Name of the new crawler.
`CreateCrawlerRequest`	`withRole(String role)` The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
`CreateCrawlerRequest`	`withSchedule(String schedule)` A `cron` expression used to specify the schedule.
`CreateCrawlerRequest`	`withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)` The policy for the crawler's update and deletion behavior.
`CreateCrawlerRequest`	`withTablePrefix(String tablePrefix)` The table prefix used for catalog tables that are created.
`CreateCrawlerRequest`	`withTags(Map<String,String> tags)` The tags to use with this crawler request.
`CreateCrawlerRequest`	`withTargets(CrawlerTargets targets)` A list of collection of targets to crawl.

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

- Constructor Detail
  - CreateCrawlerRequest
```
public CreateCrawlerRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    Name of the new crawler.
    
    Parameters:
    
    name - Name of the new crawler.
  - getName
```
public String getName()
```
    Name of the new crawler.
    
    Returns:
    
    Name of the new crawler.
  - withName
```
public CreateCrawlerRequest withName(String name)
```
    Name of the new crawler.
    
    Parameters:
    
    name - Name of the new crawler.
    
    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 Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
    
    Parameters:
    
    role - The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
  - getRole
```
public String getRole()
```
    The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
    
    Returns:
    
    The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
  - withRole
```
public CreateCrawlerRequest withRole(String role)
```
    The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
    
    Parameters:
    
    role - The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDatabaseName
```
public void setDatabaseName(String databaseName)
```
    The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
    
    Parameters:
    
    databaseName - The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
  - getDatabaseName
```
public String getDatabaseName()
```
    The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
    
    Returns:
    
    The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
  - withDatabaseName
```
public CreateCrawlerRequest withDatabaseName(String databaseName)
```
    The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
    
    Parameters:
    
    databaseName - The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.
    
    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 new crawler.
    
    Parameters:
    
    description - A description of the new crawler.
  - getDescription
```
public String getDescription()
```
    A description of the new crawler.
    
    Returns:
    
    A description of the new crawler.
  - withDescription
```
public CreateCrawlerRequest withDescription(String description)
```
    A description of the new crawler.
    
    Parameters:
    
    description - A description of the new crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargets
```
public void setTargets(CrawlerTargets targets)
```
    A list of collection of targets to crawl.
    
    Parameters:
    
    targets - A list of collection of targets to crawl.
  - getTargets
```
public CrawlerTargets getTargets()
```
    A list of collection of targets to crawl.
    
    Returns:
    
    A list of collection of targets to crawl.
  - withTargets
```
public CreateCrawlerRequest withTargets(CrawlerTargets targets)
```
    A list of collection of targets to crawl.
    
    Parameters:
    
    targets - A list of collection of targets to crawl.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchedule
```
public void setSchedule(String schedule)
```
    A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
    
    Parameters:
    
    schedule - A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
  - getSchedule
```
public String getSchedule()
```
    A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
    
    Returns:
    
    A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
  - withSchedule
```
public CreateCrawlerRequest withSchedule(String schedule)
```
    A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
    
    Parameters:
    
    schedule - A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).
    
    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 that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    Returns:
    
    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
  - setClassifiers
```
public void setClassifiers(Collection<String> classifiers)
```
    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    Parameters:
    
    classifiers - A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
  - withClassifiers
```
public CreateCrawlerRequest withClassifiers(String... classifiers)
```
    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    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 that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withClassifiers
```
public CreateCrawlerRequest withClassifiers(Collection<String> classifiers)
```
    A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    Parameters:
    
    classifiers - A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTablePrefix
```
public void setTablePrefix(String tablePrefix)
```
    The table prefix used for catalog tables that are created.
    
    Parameters:
    
    tablePrefix - The table prefix used for catalog tables that are created.
  - getTablePrefix
```
public String getTablePrefix()
```
    The table prefix used for catalog tables that are created.
    
    Returns:
    
    The table prefix used for catalog tables that are created.
  - withTablePrefix
```
public CreateCrawlerRequest withTablePrefix(String tablePrefix)
```
    The table prefix used for catalog tables that are created.
    
    Parameters:
    
    tablePrefix - The table prefix used for catalog tables that are created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchemaChangePolicy
```
public void setSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    The policy for the crawler's update and deletion behavior.
    
    Parameters:
    
    schemaChangePolicy - The policy for the crawler's update and deletion behavior.
  - getSchemaChangePolicy
```
public SchemaChangePolicy getSchemaChangePolicy()
```
    The policy for the crawler's update and deletion behavior.
    
    Returns:
    
    The policy for the crawler's update and deletion behavior.
  - withSchemaChangePolicy
```
public CreateCrawlerRequest withSchemaChangePolicy(SchemaChangePolicy schemaChangePolicy)
```
    The policy for the crawler's update and deletion behavior.
    
    Parameters:
    
    schemaChangePolicy - The policy for the crawler's update and deletion behavior.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfiguration
```
public void setConfiguration(String configuration)
```
    The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
    
    Parameters:
    
    configuration - The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
  - getConfiguration
```
public String getConfiguration()
```
    The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
    
    Returns:
    
    The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
  - withConfiguration
```
public CreateCrawlerRequest withConfiguration(String configuration)
```
    The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
    
    Parameters:
    
    configuration - The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCrawlerSecurityConfiguration
```
public void setCrawlerSecurityConfiguration(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.
  - getCrawlerSecurityConfiguration
```
public String getCrawlerSecurityConfiguration()
```
    The name of the SecurityConfiguration structure to be used by this crawler.
    
    Returns:
    
    The name of the SecurityConfiguration structure to be used by this crawler.
  - withCrawlerSecurityConfiguration
```
public CreateCrawlerRequest withCrawlerSecurityConfiguration(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.
  - getTags
```
public Map<String,String> getTags()
```
    The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
    
    Returns:
    
    The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
    
    Parameters:
    
    tags - The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
  - withTags
```
public CreateCrawlerRequest withTags(Map<String,String> tags)
```
    The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
    
    Parameters:
    
    tags - The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateCrawlerRequest addTagsEntry(String key,
                                         String value)
```
  - clearTagsEntries
```
public CreateCrawlerRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 CreateCrawlerRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateCrawlerRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateCrawlerRequest

Method Detail

setName

getName

withName

setRole

getRole

withRole

setDatabaseName

getDatabaseName

withDatabaseName

setDescription

getDescription

withDescription

setTargets

getTargets

withTargets

setSchedule

getSchedule

withSchedule

getClassifiers

setClassifiers

withClassifiers

withClassifiers

setTablePrefix

getTablePrefix

withTablePrefix

setSchemaChangePolicy

getSchemaChangePolicy

withSchemaChangePolicy

setConfiguration

getConfiguration

withConfiguration

setCrawlerSecurityConfiguration

getCrawlerSecurityConfiguration

withCrawlerSecurityConfiguration

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone