You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Glue::Types::Crawler

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Specifies a crawler program that examines a data source and uses classifiers to try to its schema. If successful, the crawler records metatdata concerning the data source in the Data Catalog.

Instance Attribute Summary collapse

Instance Attribute Details

#classifiersArray<String>

A list of custom Classifiers associated with this Crawler.

Returns:

  • (Array<String>)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#crawl_elapsed_timeInteger

If this Crawler is running, contains the total time elapsed since the last crawl began.

Returns:

  • (Integer)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#creation_timeTime

The time when the Crawler was created.

Returns:

  • (Time)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#database_nameString

The Database where this Crawler's output should be stored.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#descriptionString

A description of this Crawler and where it should be used.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#last_crawlTypes::LastCrawlInfo

The status of the last crawl, and potentially error information if an error occurred.



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#last_updatedTime

The time the Crawler was last updated.

Returns:

  • (Time)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#nameString

The Crawler name.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#roleString

The ARN of an IAM role used to access customer resources such as data in S3.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#scheduleTypes::Schedule

A Schedule object that specifies the schedule on which this Crawler is to be run.

Returns:



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#schema_change_policyTypes::SchemaChangePolicy

Sets policy for the crawler's update and delete behavior.



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#stateString

Indicates whether this Crawler is running, or whether a run is pending.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#table_prefixString

The table prefix used for catalog tables created.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#targetsTypes::CrawlerTargets

A collection of targets to crawl.



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end

#versionInteger

The version of the Crawler.

Returns:

  • (Integer)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 769

class Crawler < Struct.new(
  :name,
  :role,
  :targets,
  :database_name,
  :description,
  :classifiers,
  :schema_change_policy,
  :state,
  :table_prefix,
  :schedule,
  :crawl_elapsed_time,
  :creation_time,
  :last_updated,
  :last_crawl,
  :version)
  include Aws::Structure
end