Class: Google::Apis::YoutubeV3::PageInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/google/apis/youtube_v3/representations.rb

Overview

Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PageInfo

Returns a new instance of PageInfo


5235
5236
5237
# File 'generated/google/apis/youtube_v3/classes.rb', line 5235

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#results_per_pageFixnum

The number of results included in the API response. Corresponds to the JSON property resultsPerPage

Returns:

  • (Fixnum)

5228
5229
5230
# File 'generated/google/apis/youtube_v3/classes.rb', line 5228

def results_per_page
  @results_per_page
end

#total_resultsFixnum

The total number of results in the result set. Corresponds to the JSON property totalResults

Returns:

  • (Fixnum)

5233
5234
5235
# File 'generated/google/apis/youtube_v3/classes.rb', line 5233

def total_results
  @total_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5240
5241
5242
5243
# File 'generated/google/apis/youtube_v3/classes.rb', line 5240

def update!(**args)
  @results_per_page = args[:results_per_page] if args.key?(:results_per_page)
  @total_results = args[:total_results] if args.key?(:total_results)
end