Class: XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy

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

Defined Under Namespace

Modules: StopReason

Instance Attribute 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:, stop_reason:, strategy:, unique_added:) ⇒ Object

Parameters:



164
165
166
167
168
169
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
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 164

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 stop_reason
  #
  #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
  required :stop_reason,
           enum: -> { XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::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

  # @!method initialize(duplicate_count:, pages_fetched:, stop_reason:, strategy:, unique_added:)
  #   @param duplicate_count [Integer]
  #   @param pages_fetched [Integer]
  #   @param stop_reason [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
  #   @param strategy [Integer]
  #   @param unique_added [Integer]

  # @see XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::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
end

Instance Attribute Details

#duplicate_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


168
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 168

required :duplicate_count, Integer, api_name: :duplicateCount

#pages_fetched ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


173
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 173

required :pages_fetched, Integer, api_name: :pagesFetched

#stop_reason ⇒ Symbol, XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason

Parameters:

  • value (XTwitterScraper::Models::X::UserRetrieveFollowersResponse::UserListCoverageResponse::Diagnostic::Strategy::stop_reason)

Returns:



178
179
180
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 178

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

#strategy ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


185
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 185

required :strategy, Integer

#unique_added ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


190
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb', line 190

required :unique_added, Integer, api_name: :uniqueAdded

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


158
 
# File 'sig/x_twitter_scraper/models/x/user_retrieve_followers_response.rbs', line 158

def to_hash: -> {