com.google.api.services.youtube.model

Class SearchListResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtube.model.SearchListResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchListResponse
extends GenericJson

A paginated list of search results returned as the response to a youtube.search.list call.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the YouTube Data API. For a detailed explanation see: http://code.google.com/p/google-api-java-client/wiki/Json

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SearchListResponse()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEtag() The ETag for the response.
String	getEventId() Serialized EventId of the request which produced this response.
List<SearchResult>	getItems() A list of results that match the search criteria.
String	getKind() The type of the API response.
String	getNextPageToken() The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
PageInfo	getPageInfo() The pageInfo object encapsulates paging information for the search result set.
String	getPrevPageToken() The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
String	getVisitorId() The visitorId identifies the visitor.
SearchListResponse	setEtag(String etag) The ETag for the response.
SearchListResponse	setEventId(String eventId) Serialized EventId of the request which produced this response.
SearchListResponse	setItems(List<SearchResult> items) A list of results that match the search criteria.
SearchListResponse	setKind(String kind) The type of the API response.
SearchListResponse	setNextPageToken(String nextPageToken) The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
SearchListResponse	setPageInfo(PageInfo pageInfo) The pageInfo object encapsulates paging information for the search result set.
SearchListResponse	setPrevPageToken(String prevPageToken) The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
SearchListResponse	setVisitorId(String visitorId) The visitorId identifies the visitor.

Methods inherited from class com.google.api.client.json.GenericJson

clone, getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchListResponse

public SearchListResponse()

Method Detail

getEtag

public String getEtag()

The ETag for the response. The value returned may be null.

setEtag

public SearchListResponse setEtag(String etag)

The ETag for the response. The value set may be null.

getEventId

public String getEventId()

Serialized EventId of the request which produced this response. The value returned may be null.

setEventId

public SearchListResponse setEventId(String eventId)

Serialized EventId of the request which produced this response. The value set may be null.

getItems

public List<SearchResult> getItems()

A list of results that match the search criteria. The value returned may be null.

setItems

public SearchListResponse setItems(List<SearchResult> items)

A list of results that match the search criteria. The value set may be null.

getKind

public String getKind()

The type of the API response. For this operation, the value will be youtube#searchListResponse. The value returned may be null.

setKind

public SearchListResponse setKind(String kind)

The type of the API response. For this operation, the value will be youtube#searchListResponse. The value set may be null.

getNextPageToken

public String getNextPageToken()

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

setNextPageToken

public SearchListResponse setNextPageToken(String nextPageToken)

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

getPageInfo

public PageInfo getPageInfo()

The pageInfo object encapsulates paging information for the search result set. The value returned may be null.

setPageInfo

public SearchListResponse setPageInfo(PageInfo pageInfo)

The pageInfo object encapsulates paging information for the search result set. The value set may be null.

getPrevPageToken

public String getPrevPageToken()

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

setPrevPageToken

public SearchListResponse setPrevPageToken(String prevPageToken)

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

getVisitorId

public String getVisitorId()

The visitorId identifies the visitor. The value returned may be null.

setVisitorId

public SearchListResponse setVisitorId(String visitorId)

The visitorId identifies the visitor. The value set may be null.