Class: XTwitterScraper::Models::ExtractionJob

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/extraction_job.rb,
sig/x_twitter_scraper/models/extraction_job.rbs

Defined Under Namespace

Modules: Status, ToolType

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, created_at:, status:, tool_type:, total_results:, completed_at: nil) ⇒ Object

Extraction job tracking status, tool type, and result count.

Parameters:




# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 37

Instance Attribute Details

#completed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


35
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 35

optional :completed_at, Time, api_name: :completedAt

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


14
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 14

required :created_at, Time, api_name: :createdAt

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


9
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 9

required :id, String

#status ⇒ Symbol, XTwitterScraper::Models::ExtractionJob::Status

Parameters:

  • value (XTwitterScraper::Models::ExtractionJob::status)

Returns:



19
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 19

required :status, enum: -> { XTwitterScraper::ExtractionJob::Status }

#tool_type ⇒ Symbol, XTwitterScraper::Models::ExtractionJob::ToolType

Identifier for the extraction tool used to run a job.

Parameters:

  • value (XTwitterScraper::Models::ExtractionJob::tool_type)

Returns:



25
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 25

required :tool_type, enum: -> { XTwitterScraper::ExtractionJob::ToolType }, api_name: :toolType

#total_results ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


30
 
# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 30

required :total_results, Integer, api_name: :totalResults

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/extraction_job.rb', line 60

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


37
 
# File 'sig/x_twitter_scraper/models/extraction_job.rbs', line 37

def to_hash: -> {