com.google.api.services.youtube.model

Class SearchResult

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.youtube.model.SearchResult

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class SearchResult
extends com.google.api.client.json.GenericJson

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

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-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SearchResult()

Method Summary

Methods

Modifier and Type	Method and Description
SearchResult	clone()
java.lang.String	getEtag() Etag of this resource.
ResourceId	getId() The id object contains information that can be used to uniquely identify the resource that matches the search request.
java.lang.String	getKind() Identifies what kind of resource this is.
SearchResultSnippet	getSnippet() The snippet object contains basic details about a search result, such as its title or description.
SearchResult	set(java.lang.String fieldName, java.lang.Object value)
SearchResult	setEtag(java.lang.String etag) Etag of this resource.
SearchResult	setId(ResourceId id) The id object contains information that can be used to uniquely identify the resource that matches the search request.
SearchResult	setKind(java.lang.String kind) Identifies what kind of resource this is.
SearchResult	setSnippet(SearchResultSnippet snippet) The snippet object contains basic details about a search result, such as its title or description.

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

getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, 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

SearchResult

public SearchResult()

Method Detail

getEtag

public java.lang.String getEtag()

Etag of this resource.

Returns:

value or null for none

setEtag

public SearchResult setEtag(java.lang.String etag)

Etag of this resource.

Parameters:

etag - etag or null for none

getId

public ResourceId getId()

The id object contains information that can be used to uniquely identify the resource that matches the search request.

Returns:

value or null for none

setId

public SearchResult setId(ResourceId id)

The id object contains information that can be used to uniquely identify the resource that matches the search request.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".

Returns:

value or null for none

setKind

public SearchResult setKind(java.lang.String kind)

Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".

Parameters:

kind - kind or null for none

getSnippet

public SearchResultSnippet getSnippet()

The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.

Returns:

value or null for none

setSnippet

public SearchResult setSnippet(SearchResultSnippet snippet)

The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.

Parameters:

snippet - snippet or null for none

set

public SearchResult set(java.lang.String fieldName,
               java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SearchResult clone()

Overrides:

clone in class com.google.api.client.json.GenericJson