Class CreateCrawlerRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.glue.model.GlueRequest
-
- software.amazon.awssdk.services.glue.model.CreateCrawlerRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCrawlerRequest extends GlueRequest implements ToCopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateCrawlerRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateCrawlerRequest.Builderbuilder()List<String>classifiers()A list of custom classifiers that the user has registered.Stringconfiguration()Crawler configuration information.StringcrawlerSecurityConfiguration()The name of theSecurityConfigurationstructure to be used by this crawler.StringdatabaseName()The Glue database where results are written, such as:arn:aws:daylight:us-east-1::database/sometable/*.Stringdescription()A description of the new crawler.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasClassifiers()For responses, this returns true if the service returned a value for the Classifiers property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.LakeFormationConfigurationlakeFormationConfiguration()Specifies Lake Formation configuration settings for the crawler.LineageConfigurationlineageConfiguration()Specifies data lineage configuration settings for the crawler.Stringname()Name of the new crawler.RecrawlPolicyrecrawlPolicy()A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.Stringrole()The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.Stringschedule()Acronexpression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers.SchemaChangePolicyschemaChangePolicy()The policy for the crawler's update and deletion behavior.List<SdkField<?>>sdkFields()static Class<? extends CreateCrawlerRequest.Builder>serializableBuilderClass()StringtablePrefix()The table prefix used for catalog tables that are created.Map<String,String>tags()The tags to use with this crawler request.CrawlerTargetstargets()A list of collection of targets to crawl.CreateCrawlerRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
Name of the new crawler.
- Returns:
- Name of the new crawler.
-
role
public final String role()
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.
-
databaseName
public final String databaseName()
The Glue database where results are written, such as:
arn:aws:daylight:us-east-1::database/sometable/*.- Returns:
- The Glue database where results are written, such as:
arn:aws:daylight:us-east-1::database/sometable/*.
-
description
public final String description()
A description of the new crawler.
- Returns:
- A description of the new crawler.
-
targets
public final CrawlerTargets targets()
A list of collection of targets to crawl.
- Returns:
- A list of collection of targets to crawl.
-
schedule
public final String schedule()
A
cronexpression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *).- Returns:
- A
cronexpression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:cron(15 12 * * ? *).
-
hasClassifiers
public final boolean hasClassifiers()
For responses, this returns true if the service returned a value for the Classifiers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
classifiers
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasClassifiers()method.- 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.
-
tablePrefix
public final String tablePrefix()
The table prefix used for catalog tables that are created.
- Returns:
- The table prefix used for catalog tables that are created.
-
schemaChangePolicy
public final SchemaChangePolicy schemaChangePolicy()
The policy for the crawler's update and deletion behavior.
- Returns:
- The policy for the crawler's update and deletion behavior.
-
recrawlPolicy
public final 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.
- Returns:
- A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.
-
lineageConfiguration
public final LineageConfiguration lineageConfiguration()
Specifies data lineage configuration settings for the crawler.
- Returns:
- Specifies data lineage configuration settings for the crawler.
-
lakeFormationConfiguration
public final LakeFormationConfiguration lakeFormationConfiguration()
Specifies Lake Formation configuration settings for the crawler.
- Returns:
- Specifies Lake Formation configuration settings for the crawler.
-
configuration
public final 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.
- Returns:
- 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.
-
crawlerSecurityConfiguration
public final String crawlerSecurityConfiguration()
The name of the
SecurityConfigurationstructure to be used by this crawler.- Returns:
- The name of the
SecurityConfigurationstructure to be used by this crawler.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final Map<String,String> tags()
The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
-
toBuilder
public CreateCrawlerRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>- Specified by:
toBuilderin classGlueRequest
-
builder
public static CreateCrawlerRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateCrawlerRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-