com.google.api.services.youtube.model

Class SearchResultSnippet

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchResultSnippet
extends GenericJson

Basic details about a search result, including title, description and thumbnails of the item referenced by the search result.

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 v3. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

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
SearchResultSnippet()

Method Summary

Modifier and Type	Method and Description
SearchResultSnippet	clone()
String	getChannelId() The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
String	getChannelTitle() The title of the channel that published the resource that the search result identifies.
String	getDescription() A description of the search result.
String	getLiveBroadcastContent() It indicates if the resource (video or channel) has upcoming/active live broadcast content.
DateTime	getPublishedAt() The creation date and time of the resource that the search result identifies.
ThumbnailDetails	getThumbnails() A map of thumbnail images associated with the search result.
String	getTitle() The title of the search result.
SearchResultSnippet	set(String fieldName, Object value)
SearchResultSnippet	setChannelId(String channelId) The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.
SearchResultSnippet	setChannelTitle(String channelTitle) The title of the channel that published the resource that the search result identifies.
SearchResultSnippet	setDescription(String description) A description of the search result.
SearchResultSnippet	setLiveBroadcastContent(String liveBroadcastContent) It indicates if the resource (video or channel) has upcoming/active live broadcast content.
SearchResultSnippet	setPublishedAt(DateTime publishedAt) The creation date and time of the resource that the search result identifies.
SearchResultSnippet	setThumbnails(ThumbnailDetails thumbnails) A map of thumbnail images associated with the search result.
SearchResultSnippet	setTitle(String title) The title of the search result.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SearchResultSnippet

public SearchResultSnippet()

Method Detail

getChannelId

public String getChannelId()

The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.

Returns:

value or null for none

setChannelId

public SearchResultSnippet setChannelId(String channelId)

The value that YouTube uses to uniquely identify the channel that published the resource that the search result identifies.

Parameters:

channelId - channelId or null for none

getChannelTitle

public String getChannelTitle()

The title of the channel that published the resource that the search result identifies.

Returns:

value or null for none

setChannelTitle

public SearchResultSnippet setChannelTitle(String channelTitle)

The title of the channel that published the resource that the search result identifies.

Parameters:

channelTitle - channelTitle or null for none

getDescription

public String getDescription()

A description of the search result.

Returns:

value or null for none

setDescription

public SearchResultSnippet setDescription(String description)

A description of the search result.

Parameters:

description - description or null for none

getLiveBroadcastContent

public String getLiveBroadcastContent()

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.

Returns:

value or null for none

setLiveBroadcastContent

public SearchResultSnippet setLiveBroadcastContent(String liveBroadcastContent)

It indicates if the resource (video or channel) has upcoming/active live broadcast content. Or it's "none" if there is not any upcoming/active live broadcasts.

Parameters:

liveBroadcastContent - liveBroadcastContent or null for none

getPublishedAt

public DateTime getPublishedAt()

The creation date and time of the resource that the search result identifies.

Returns:

value or null for none

setPublishedAt

public SearchResultSnippet setPublishedAt(DateTime publishedAt)

The creation date and time of the resource that the search result identifies.

Parameters:

publishedAt - publishedAt or null for none

getThumbnails

public ThumbnailDetails getThumbnails()

A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

Returns:

value or null for none

setThumbnails

public SearchResultSnippet setThumbnails(ThumbnailDetails thumbnails)

A map of thumbnail images associated with the search result. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.

Parameters:

thumbnails - thumbnails or null for none

getTitle

public String getTitle()

The title of the search result.

Returns:

value or null for none

setTitle

public SearchResultSnippet setTitle(String title)

The title of the search result.

Parameters:

title - title or null for none

set

public SearchResultSnippet set(String fieldName,
                               Object value)

Overrides:

set in class GenericJson

clone

public SearchResultSnippet clone()

Overrides:

clone in class GenericJson