Class: XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/x_twitter_scraper/models/x/tweet_search_response.rb,
sig/x_twitter_scraper/models/x/tweet_search_response.rbs

Defined Under Namespace

Modules: QueryType, StopReason Classes: Window

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(duplicate_count:, pages_fetched:, query_type:, stop_reason:, strategy:, unique_added:, window: nil) ⇒ Object

Parameters:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 170

class Strategy < XTwitterScraper::Internal::Type::BaseModel
  # @!attribute duplicate_count
  #
  #   @return [Integer]
  required :duplicate_count, Integer, api_name: :duplicateCount

  # @!attribute pages_fetched
  #
  #   @return [Integer]
  required :pages_fetched, Integer, api_name: :pagesFetched

  # @!attribute query_type
  #
  #   @return [Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::QueryType]
  required :query_type,
           enum: -> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::QueryType },
           api_name: :queryType

  # @!attribute stop_reason
  #
  #   @return [Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::StopReason]
  required :stop_reason,
           enum: -> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::StopReason },
           api_name: :stopReason

  # @!attribute strategy
  #
  #   @return [Integer]
  required :strategy, Integer

  # @!attribute unique_added
  #
  #   @return [Integer]
  required :unique_added, Integer, api_name: :uniqueAdded

  # @!attribute window
  #   Non-overlapping time partition used by one strategy.
  #
  #   @return [XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::Window, nil]
  optional :window,
           -> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::Window }

  # @!method initialize(duplicate_count:, pages_fetched:, query_type:, stop_reason:, strategy:, unique_added:, window: nil)
  #   @param duplicate_count [Integer]
  #
  #   @param pages_fetched [Integer]
  #
  #   @param query_type [Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::QueryType]
  #
  #   @param stop_reason [Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::StopReason]
  #
  #   @param strategy [Integer]
  #
  #   @param unique_added [Integer]
  #
  #   @param window [XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::Window] Non-overlapping time partition used by one strategy.

  # @see XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy#query_type
  module QueryType
    extend XTwitterScraper::Internal::Type::Enum

    LATEST = :Latest
    TOP = :Top

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy#stop_reason
  module StopReason
    extend XTwitterScraper::Internal::Type::Enum

    CURSOR_FAILURE = :cursor_failure
    DEADLINE = :deadline
    EXHAUSTED = :exhausted
    FAILED = :failed
    PAGE_LIMIT = :page_limit
    RESULT_LIMIT = :result_limit
    STALLED = :stalled

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy#window
  class Window < XTwitterScraper::Internal::Type::BaseModel
    # @!attribute since_time
    #
    #   @return [Time]
    required :since_time, Time, api_name: :sinceTime

    # @!attribute until_time
    #
    #   @return [Time]
    required :until_time, Time, api_name: :untilTime

    # @!method initialize(since_time:, until_time:)
    #   Non-overlapping time partition used by one strategy.
    #
    #   @param since_time [Time]
    #   @param until_time [Time]
  end
end

Instance Attribute Details

#duplicate_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


174
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 174

required :duplicate_count, Integer, api_name: :duplicateCount

#pages_fetched ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


179
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 179

required :pages_fetched, Integer, api_name: :pagesFetched

#query_type ⇒ Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::QueryType

Parameters:

  • value (XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::query_type)

Returns:



184
185
186
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 184

required :query_type,
enum: -> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::QueryType },
api_name: :queryType

#stop_reason ⇒ Symbol, XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::StopReason

Parameters:

  • value (XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::stop_reason)

Returns:



191
192
193
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 191

required :stop_reason,
enum: -> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::StopReason },
api_name: :stopReason

#strategy ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


198
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 198

required :strategy, Integer

#unique_added ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


203
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 203

required :unique_added, Integer, api_name: :uniqueAdded

#window ⇒ XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::Window?

Non-overlapping time partition used by one strategy.

Returns:



209
210
 
# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 209

optional :window,
-> { XTwitterScraper::Models::X::TweetSearchResponse::TweetSearchCoverageResponse::Diagnostic::Strategy::Window }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/x/tweet_search_response.rb', line 234

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


175
 
# File 'sig/x_twitter_scraper/models/x/tweet_search_response.rbs', line 175

def to_hash: -> {