Class: Google::Apis::YoutubeV3::SearchListsResponse

Inherits:

Object

• Object
• Google::Apis::YoutubeV3::SearchListsResponse

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 more...

Instance Attribute Summary

• #etag ⇒ String

  Etag of this resource.

• #event_id ⇒ String

  Serialized EventId of the request which produced this response.

• #items ⇒ Array<Google::Apis::YoutubeV3::SearchResult>

  A list of results that match the search criteria.

• #kind ⇒ String

  Identifies what kind of resource this is.

• #next_page_token ⇒ String

  The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.

• #page_info ⇒ Google::Apis::YoutubeV3::PageInfo

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

• #prev_page_token ⇒ String

  The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.

• #region_code ⇒ String

  Corresponds to the JSON property regionCode.

• #token_pagination ⇒ Google::Apis::YoutubeV3::TokenPagination

  Stub token pagination template to suppress results.

• #visitor_id ⇒ String

  The visitorId identifies the visitor.

Instance Method Summary

• #initialize(**args) ⇒ SearchListsResponse constructor

  A new instance of SearchListsResponse.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchListsResponse

Returns a new instance of SearchListsResponse

# File 'generated/google/apis/youtube_v3/classes.rb', line 6080

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

Instance Attribute Details

#etag ⇒ String

Etag of this resource. Corresponds to the JSON property etag

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6029

def etag
  @etag
end

#event_id ⇒ String

Serialized EventId of the request which produced this response. Corresponds to the JSON property eventId

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6034

def event_id
  @event_id
end

#items ⇒ Array<Google::Apis::YoutubeV3::SearchResult>

A list of results that match the search criteria. Corresponds to the JSON property items

Returns:

• (Array<Google::Apis::YoutubeV3::SearchResult>)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6039

def items
  @items
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "youtube# searchListResponse". Corresponds to the JSON property kind

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6045

def kind
  @kind
end

#next_page_token ⇒ String

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. Corresponds to the JSON property nextPageToken

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6051

def next_page_token
  @next_page_token
end

#page_info ⇒ Google::Apis::YoutubeV3::PageInfo

Paging details for lists of resources, including total number of items available and number of resources returned in a single page. Corresponds to the JSON property pageInfo

Returns:

• (Google::Apis::YoutubeV3::PageInfo)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6057

def page_info
  @page_info
end

#prev_page_token ⇒ String

The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. Corresponds to the JSON property prevPageToken

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6063

def prev_page_token
  @prev_page_token
end

#region_code ⇒ String

Corresponds to the JSON property regionCode

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6068

def region_code
  @region_code
end

#token_pagination ⇒ Google::Apis::YoutubeV3::TokenPagination

Stub token pagination template to suppress results. Corresponds to the JSON property tokenPagination

Returns:

• (Google::Apis::YoutubeV3::TokenPagination)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6073

def token_pagination
  @token_pagination
end

#visitor_id ⇒ String

The visitorId identifies the visitor. Corresponds to the JSON property visitorId

Returns:

• (String)

# File 'generated/google/apis/youtube_v3/classes.rb', line 6078

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/youtube_v3/classes.rb', line 6085

def update!(**args)
  @etag = args[:etag] if args.key?(:etag)
  @event_id = args[:event_id] if args.key?(:event_id)
  @items = args[:items] if args.key?(:items)
  @kind = args[:kind] if args.key?(:kind)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @page_info = args[:page_info] if args.key?(:page_info)
  @prev_page_token = args[:prev_page_token] if args.key?(:prev_page_token)
  @region_code = args[:region_code] if args.key?(:region_code)
  @token_pagination = args[:token_pagination] if args.key?(:token_pagination)
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
end