Class UpdateCrawlerRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateCrawlerRequest.Builder,
UpdateCrawlerRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateCrawlerRequest.Builder
builder()
A list of custom classifiers that the user has registered.final String
Crawler configuration information.final String
The name of theSecurityConfiguration
structure to be used by this crawler.final String
The Glue database where results are stored, such as:arn:aws:daylight:us-east-1::database/sometable/*
.final String
A description of the new crawler.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Classifiers property.final int
hashCode()
Specifies Lake Formation configuration settings for the crawler.final LineageConfiguration
Specifies data lineage configuration settings for the crawler.final String
name()
Name of the new crawler.final 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.final String
role()
The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.final String
schedule()
Acron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers.final SchemaChangePolicy
The policy for the crawler's update and deletion behavior.static Class
<? extends UpdateCrawlerRequest.Builder> final String
The table prefix used for catalog tables that are created.final CrawlerTargets
targets()
A list of targets to crawl.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
Name of the new crawler.
- Returns:
- Name of the new crawler.
-
role
The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
- Returns:
- The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.
-
databaseName
The Glue database where results are stored, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.- Returns:
- The Glue database where results are stored, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.
-
description
A description of the new crawler.
- Returns:
- A description of the new crawler.
-
targets
A list of targets to crawl.
- Returns:
- A list of targets to crawl.
-
schedule
A
cron
expression 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
cron
expression 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
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
The table prefix used for catalog tables that are created.
- Returns:
- The table prefix used for catalog tables that are created.
-
schemaChangePolicy
The policy for the crawler's update and deletion behavior.
- Returns:
- The policy for the crawler's update and deletion behavior.
-
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
Specifies data lineage configuration settings for the crawler.
- Returns:
- Specifies data lineage configuration settings for the crawler.
-
lakeFormationConfiguration
Specifies Lake Formation configuration settings for the crawler.
- Returns:
- Specifies Lake Formation configuration settings for the crawler.
-
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
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateCrawlerRequest.Builder,
UpdateCrawlerRequest> - Specified by:
toBuilder
in classGlueRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-