com.google.api.services.youtube

Class YouTube.Thumbnails.Set

java.lang.Object

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

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.youtube.YouTubeRequest<ThumbnailSetResponse>

com.google.api.services.youtube.YouTube.Thumbnails.Set

All Implemented Interfaces:

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

Enclosing class:

YouTube.Thumbnails

public class YouTube.Thumbnails.Set
extends YouTubeRequest<ThumbnailSetResponse>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	YouTube.Thumbnails.Set(java.lang.String videoId) Uploads a custom video thumbnail to YouTube and sets it for a video.
protected	YouTube.Thumbnails.Set(java.lang.String videoId, com.google.api.client.http.AbstractInputStreamContent mediaContent) Uploads a custom video thumbnail to YouTube and sets it for a video.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getOnBehalfOfContentOwner() Note: This parameter is intended exclusively for YouTube content partners.
java.lang.String	getVideoId() The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.
YouTube.Thumbnails.Set	set(java.lang.String parameterName, java.lang.Object value)
YouTube.Thumbnails.Set	setAlt(java.lang.String alt) Data format for the response.
YouTube.Thumbnails.Set	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTube.Thumbnails.Set	setKey(java.lang.String key) API key.
YouTube.Thumbnails.Set	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTube.Thumbnails.Set	setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner) Note: This parameter is intended exclusively for YouTube content partners.
YouTube.Thumbnails.Set	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Thumbnails.Set	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
YouTube.Thumbnails.Set	setUserIp(java.lang.String userIp) IP address of the site where the request originates.
YouTube.Thumbnails.Set	setVideoId(java.lang.String videoId) The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.

Methods inherited from class com.google.api.services.youtube.YouTubeRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

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

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

YouTube.Thumbnails.Set

protected YouTube.Thumbnails.Set(java.lang.String videoId)

Uploads a custom video thumbnail to YouTube and sets it for a video. Create a request for the method "thumbnails.set". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

videoId - The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.

Since:

1.13

YouTube.Thumbnails.Set

protected YouTube.Thumbnails.Set(java.lang.String videoId,
                      com.google.api.client.http.AbstractInputStreamContent mediaContent)

Uploads a custom video thumbnail to YouTube and sets it for a video. Create a request for the method "thumbnails.set". This request holds the parameters needed by the the youtube server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

YouTube.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

This constructor should be used for uploading media content.

Parameters:

videoId - The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public YouTube.Thumbnails.Set setAlt(java.lang.String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<ThumbnailSetResponse>

setFields

public YouTube.Thumbnails.Set setFields(java.lang.String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<ThumbnailSetResponse>

setKey

public YouTube.Thumbnails.Set setKey(java.lang.String key)

Description copied from class: YouTubeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class YouTubeRequest<ThumbnailSetResponse>

setOauthToken

public YouTube.Thumbnails.Set setOauthToken(java.lang.String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<ThumbnailSetResponse>

setPrettyPrint

public YouTube.Thumbnails.Set setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<ThumbnailSetResponse>

setQuotaUser

public YouTube.Thumbnails.Set setQuotaUser(java.lang.String quotaUser)

Description copied from class: YouTubeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class YouTubeRequest<ThumbnailSetResponse>

setUserIp

public YouTube.Thumbnails.Set setUserIp(java.lang.String userIp)

Description copied from class: YouTubeRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class YouTubeRequest<ThumbnailSetResponse>

getVideoId

public java.lang.String getVideoId()

The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.

setVideoId

public YouTube.Thumbnails.Set setVideoId(java.lang.String videoId)

The videoId parameter specifies a YouTube video ID for which the custom video thumbnail is being provided.

getOnBehalfOfContentOwner

public java.lang.String getOnBehalfOfContentOwner()

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

setOnBehalfOfContentOwner

public YouTube.Thumbnails.Set setOnBehalfOfContentOwner(java.lang.String onBehalfOfContentOwner)

Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

set

public YouTube.Thumbnails.Set set(java.lang.String parameterName,
                         java.lang.Object value)

Overrides:

set in class YouTubeRequest<ThumbnailSetResponse>