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>

  • Method Details

    • 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 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 the isEmpty() 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 SecurityConfiguration structure to be used by this crawler.

      Returns:
      The name of the SecurityConfiguration structure 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 the isEmpty() 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()
      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 interface ToCopyableBuilder<CreateCrawlerRequest.Builder,CreateCrawlerRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCrawlerRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCrawlerRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.