com.google.api.services.youtube.model

Class Subscription

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

All Implemented Interfaces:

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

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

A subscription resource contains information about a YouTube user subscription. A subscription notifies a user when new videos are added to a channel or when another user takes one of several actions on YouTube, such as uploading a video, rating a video, or commenting on a video.

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

Method Summary

Methods

Modifier and Type	Method and Description
Subscription	clone()
SubscriptionContentDetails	getContentDetails() The contentDetails object contains basic statistics about the subscription.
java.lang.String	getEtag() Etag of this resource.
java.lang.String	getId() The ID that YouTube uses to uniquely identify the subscription.
java.lang.String	getKind() Identifies what kind of resource this is.
SubscriptionSnippet	getSnippet() The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.
SubscriptionSubscriberSnippet	getSubscriberSnippet() The subscriberSnippet object contains basic details about the sbuscriber.
Subscription	set(java.lang.String fieldName, java.lang.Object value)
Subscription	setContentDetails(SubscriptionContentDetails contentDetails) The contentDetails object contains basic statistics about the subscription.
Subscription	setEtag(java.lang.String etag) Etag of this resource.
Subscription	setId(java.lang.String id) The ID that YouTube uses to uniquely identify the subscription.
Subscription	setKind(java.lang.String kind) Identifies what kind of resource this is.
Subscription	setSnippet(SubscriptionSnippet snippet) The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.
Subscription	setSubscriberSnippet(SubscriptionSubscriberSnippet subscriberSnippet) The subscriberSnippet object contains basic details about the sbuscriber.

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

Subscription

public Subscription()

Method Detail

getContentDetails

public SubscriptionContentDetails getContentDetails()

The contentDetails object contains basic statistics about the subscription.

Returns:

value or null for none

setContentDetails

public Subscription setContentDetails(SubscriptionContentDetails contentDetails)

The contentDetails object contains basic statistics about the subscription.

Parameters:

contentDetails - contentDetails or null for none

getEtag

public java.lang.String getEtag()

Etag of this resource.

Returns:

value or null for none

setEtag

public Subscription setEtag(java.lang.String etag)

Etag of this resource.

Parameters:

etag - etag or null for none

getId

public java.lang.String getId()

The ID that YouTube uses to uniquely identify the subscription.

Returns:

value or null for none

setId

public Subscription setId(java.lang.String id)

The ID that YouTube uses to uniquely identify the subscription.

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#subscription".

Returns:

value or null for none

setKind

public Subscription setKind(java.lang.String kind)

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

Parameters:

kind - kind or null for none

getSnippet

public SubscriptionSnippet getSnippet()

The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.

Returns:

value or null for none

setSnippet

public Subscription setSnippet(SubscriptionSnippet snippet)

The snippet object contains basic details about the subscription, including its title and the channel that the user subscribed to.

Parameters:

snippet - snippet or null for none

getSubscriberSnippet

public SubscriptionSubscriberSnippet getSubscriberSnippet()

The subscriberSnippet object contains basic details about the sbuscriber.

Returns:

value or null for none

setSubscriberSnippet

public Subscription setSubscriberSnippet(SubscriptionSubscriberSnippet subscriberSnippet)

The subscriberSnippet object contains basic details about the sbuscriber.

Parameters:

subscriberSnippet - subscriberSnippet or null for none

set

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

Overrides:

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

clone

public Subscription clone()

Overrides:

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