com.google.api.services.youtube

Class YouTubeRequest<T>

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<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

YouTube.Activities.Insert, YouTube.Activities.List, YouTube.Captions.Delete, YouTube.Captions.Download, YouTube.Captions.Insert, YouTube.Captions.List, YouTube.Captions.Update, YouTube.ChannelBanners.Insert, YouTube.Channels.List, YouTube.Channels.Update, YouTube.ChannelSections.Delete, YouTube.ChannelSections.Insert, YouTube.ChannelSections.List, YouTube.ChannelSections.Update, YouTube.Comments.Delete, YouTube.Comments.Insert, YouTube.Comments.List, YouTube.Comments.MarkAsSpam, YouTube.Comments.SetModerationStatus, YouTube.Comments.Update, YouTube.CommentThreads.Insert, YouTube.CommentThreads.List, YouTube.CommentThreads.Update, YouTube.GuideCategories.List, YouTube.I18nLanguages.List, YouTube.I18nRegions.List, YouTube.LiveBroadcasts.Bind, YouTube.LiveBroadcasts.Control, YouTube.LiveBroadcasts.Delete, YouTube.LiveBroadcasts.Insert, YouTube.LiveBroadcasts.List, YouTube.LiveBroadcasts.Transition, YouTube.LiveBroadcasts.Update, YouTube.LiveChatBans.Delete, YouTube.LiveChatBans.Insert, YouTube.LiveChatMessages.Delete, YouTube.LiveChatMessages.Insert, YouTube.LiveChatMessages.List, YouTube.LiveChatModerators.Delete, YouTube.LiveChatModerators.Insert, YouTube.LiveChatModerators.List, YouTube.LiveStreams.Delete, YouTube.LiveStreams.Insert, YouTube.LiveStreams.List, YouTube.LiveStreams.Update, YouTube.Members.List, YouTube.MembershipsLevels.List, YouTube.PlaylistItems.Delete, YouTube.PlaylistItems.Insert, YouTube.PlaylistItems.List, YouTube.PlaylistItems.Update, YouTube.Playlists.Delete, YouTube.Playlists.Insert, YouTube.Playlists.List, YouTube.Playlists.Update, YouTube.Search.List, YouTube.Sponsors.List, YouTube.Subscriptions.Delete, YouTube.Subscriptions.Insert, YouTube.Subscriptions.List, YouTube.SuperChatEvents.List, YouTube.Thumbnails.Set, YouTube.VideoAbuseReportReasons.List, YouTube.VideoCategories.List, YouTube.Videos.Delete, YouTube.Videos.GetRating, YouTube.Videos.Insert, YouTube.Videos.List, YouTube.Videos.Rate, YouTube.Videos.ReportAbuse, YouTube.Videos.Update, YouTube.Watermarks.Set, YouTube.Watermarks.Unset

public abstract class YouTubeRequest<T>
extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

YouTube request.

Since:

1.3

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

Constructor and Description
YouTubeRequest(YouTube client, java.lang.String method, java.lang.String uriTemplate, java.lang.Object content, java.lang.Class<T> responseClass)

Method Summary

Modifier and Type	Method and Description
YouTube	getAbstractGoogleClient()
java.lang.String	getAlt() Data format for the response.
java.lang.String	getFields() Selector specifying which fields to include in a partial response.
java.lang.String	getKey() API key.
java.lang.String	getOauthToken() OAuth 2.0 token for the current user.
java.lang.Boolean	getPrettyPrint() Returns response with indentations and line breaks.
java.lang.String	getQuotaUser() An opaque string that represents a user for quota purposes.
java.lang.String	getUserIp() Deprecated.
YouTubeRequest<T>	set(java.lang.String parameterName, java.lang.Object value)
YouTubeRequest<T>	setAlt(java.lang.String alt) Data format for the response.
YouTubeRequest<T>	setDisableGZipContent(boolean disableGZipContent)
YouTubeRequest<T>	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
YouTubeRequest<T>	setKey(java.lang.String key) API key.
YouTubeRequest<T>	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
YouTubeRequest<T>	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
YouTubeRequest<T>	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
YouTubeRequest<T>	setRequestHeaders(com.google.api.client.http.HttpHeaders headers)
YouTubeRequest<T>	setUserIp(java.lang.String userIp) Deprecated.

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

Methods inherited from interface java.util.Map

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

Constructor Detail

YouTubeRequest

public YouTubeRequest(YouTube client,
                      java.lang.String method,
                      java.lang.String uriTemplate,
                      java.lang.Object content,
                      java.lang.Class<T> responseClass)

Parameters:

client - Google client

method - HTTP Method

uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)

content - A POJO that can be serialized into JSON or null for none

responseClass - response class to parse into

Method Detail

getAlt

public java.lang.String getAlt()

Data format for the response. [default: json]

setAlt

public YouTubeRequest<T> setAlt(java.lang.String alt)

Data format for the response.

getFields

public java.lang.String getFields()

Selector specifying which fields to include in a partial response.

setFields

public YouTubeRequest<T> setFields(java.lang.String fields)

Selector specifying which fields to include in a partial response.

getKey

public java.lang.String getKey()

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.

setKey

public YouTubeRequest<T> setKey(java.lang.String key)

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.

getOauthToken

public java.lang.String getOauthToken()

OAuth 2.0 token for the current user.

setOauthToken

public YouTubeRequest<T> setOauthToken(java.lang.String oauthToken)

OAuth 2.0 token for the current user.

getPrettyPrint

public java.lang.Boolean getPrettyPrint()

Returns response with indentations and line breaks. [default: true]

setPrettyPrint

public YouTubeRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)

Returns response with indentations and line breaks.

getQuotaUser

public java.lang.String getQuotaUser()

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

setQuotaUser

public YouTubeRequest<T> setQuotaUser(java.lang.String quotaUser)

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

getUserIp

public java.lang.String getUserIp()

Deprecated. Please use quotaUser instead.

setUserIp

public YouTubeRequest<T> setUserIp(java.lang.String userIp)

Deprecated. Please use quotaUser instead.

getAbstractGoogleClient

public final YouTube getAbstractGoogleClient()

Overrides:

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

setDisableGZipContent

public YouTubeRequest<T> setDisableGZipContent(boolean disableGZipContent)

Overrides:

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

setRequestHeaders

public YouTubeRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)

Overrides:

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

set

public YouTubeRequest<T> set(java.lang.String parameterName,
                             java.lang.Object value)

Overrides:

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