com.google.api.services.youtube

Class YouTube.Videos.Rate

java.lang.Object

java.util.AbstractMap<String,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<Void>

com.google.api.services.youtube.YouTube.Videos.Rate

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Videos

public class YouTube.Videos.Rate
extends YouTubeRequest<Void>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rate(String id, String rating) Add a like or dislike rating to a video or remove a rating from a video.

Method Summary

Modifier and Type	Method and Description
String	getId() The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.
String	getRating() Specifies the rating to record.
YouTube.Videos.Rate	set(String parameterName, Object value)
YouTube.Videos.Rate	setAlt(String alt) Data format for the response.
YouTube.Videos.Rate	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Videos.Rate	setId(String id) The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.
YouTube.Videos.Rate	setKey(String key) API key.
YouTube.Videos.Rate	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Videos.Rate	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Videos.Rate	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Videos.Rate	setRating(String rating) Specifies the rating to record.
YouTube.Videos.Rate	setUserIp(String userIp) Deprecated.

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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

Rate

protected Rate(String id,
               String rating)

Add a like or dislike rating to a video or remove a rating from a video. Create a request for the method "videos.rate". 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:

id - The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.

rating - Specifies the rating to record.

Since:

1.13

Method Detail

setAlt

public YouTube.Videos.Rate setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<Void>

setFields

public YouTube.Videos.Rate setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<Void>

setKey

public YouTube.Videos.Rate setKey(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<Void>

setOauthToken

public YouTube.Videos.Rate setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<Void>

setPrettyPrint

public YouTube.Videos.Rate setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<Void>

setQuotaUser

public YouTube.Videos.Rate setQuotaUser(String quotaUser)

Description copied from class: YouTubeRequest

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

Overrides:

setQuotaUser in class YouTubeRequest<Void>

setUserIp

public YouTube.Videos.Rate setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<Void>

getId

public String getId()

The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.

setId

public YouTube.Videos.Rate setId(String id)

The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.

getRating

public String getRating()

Specifies the rating to record.

setRating

public YouTube.Videos.Rate setRating(String rating)

Specifies the rating to record.

set

public YouTube.Videos.Rate set(String parameterName,
                               Object value)

Overrides:

set in class YouTubeRequest<Void>