com.google.api.services.youtube

Class YouTube.Comments.List

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

com.google.api.services.youtube.YouTube.Comments.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

YouTube.Comments

public class YouTube.Comments.List
extends YouTubeRequest<CommentListResponse>

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	List(String part) Returns a list of comments that match the API request parameters.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getId() The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved.
Long	getMaxResults() The maxResults parameter specifies the maximum number of items that should be returned in the result set.
String	getPageToken() The pageToken parameter identifies a specific page in the result set that should be returned.
String	getParentId() The parentId parameter specifies the ID of the comment for which replies should be retrieved.
String	getPart() The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.
String	getTextFormat() This parameter indicates whether the API should return comments formatted as HTML or as plain text.
YouTube.Comments.List	set(String parameterName, Object value)
YouTube.Comments.List	setAlt(String alt) Data format for the response.
YouTube.Comments.List	setFields(String fields) Selector specifying which fields to include in a partial response.
YouTube.Comments.List	setId(String id) The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved.
YouTube.Comments.List	setKey(String key) API key.
YouTube.Comments.List	setMaxResults(Long maxResults) The maxResults parameter specifies the maximum number of items that should be returned in the result set.
YouTube.Comments.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
YouTube.Comments.List	setPageToken(String pageToken) The pageToken parameter identifies a specific page in the result set that should be returned.
YouTube.Comments.List	setParentId(String parentId) The parentId parameter specifies the ID of the comment for which replies should be retrieved.
YouTube.Comments.List	setPart(String part) The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.
YouTube.Comments.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
YouTube.Comments.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
YouTube.Comments.List	setTextFormat(String textFormat) This parameter indicates whether the API should return comments formatted as HTML or as plain text.
YouTube.Comments.List	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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

List

protected List(String part)

Returns a list of comments that match the API request parameters. Create a request for the method "comments.list". 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:

part - The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<CommentListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<CommentListResponse>

Throws:

IOException

setAlt

public YouTube.Comments.List setAlt(String alt)

Description copied from class: YouTubeRequest

Data format for the response.

Overrides:

setAlt in class YouTubeRequest<CommentListResponse>

setFields

public YouTube.Comments.List setFields(String fields)

Description copied from class: YouTubeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class YouTubeRequest<CommentListResponse>

setKey

public YouTube.Comments.List 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<CommentListResponse>

setOauthToken

public YouTube.Comments.List setOauthToken(String oauthToken)

Description copied from class: YouTubeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class YouTubeRequest<CommentListResponse>

setPrettyPrint

public YouTube.Comments.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: YouTubeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class YouTubeRequest<CommentListResponse>

setQuotaUser

public YouTube.Comments.List 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<CommentListResponse>

setUserIp

public YouTube.Comments.List setUserIp(String userIp)

Description copied from class: YouTubeRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class YouTubeRequest<CommentListResponse>

getPart

public String getPart()

The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.

setPart

public YouTube.Comments.List setPart(String part)

The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.

getId

public String getId()

The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.

setId

public YouTube.Comments.List setId(String id)

The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.

getMaxResults

public Long getMaxResults()

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is not supported for use in conjunction with the id parameter. [default: 20] [minimum: 1] [maximum: 100]

setMaxResults

public YouTube.Comments.List setMaxResults(Long maxResults)

The maxResults parameter specifies the maximum number of items that should be returned in the result set. Note: This parameter is not supported for use in conjunction with the id parameter.

getPageToken

public String getPageToken()

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. Note: This parameter is not supported for use in conjunction with the id parameter.

setPageToken

public YouTube.Comments.List setPageToken(String pageToken)

The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved. Note: This parameter is not supported for use in conjunction with the id parameter.

getParentId

public String getParentId()

The parentId parameter specifies the ID of the comment for which replies should be retrieved. Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.

setParentId

public YouTube.Comments.List setParentId(String parentId)

The parentId parameter specifies the ID of the comment for which replies should be retrieved. Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.

getTextFormat

public String getTextFormat()

This parameter indicates whether the API should return comments formatted as HTML or as plain text. [default: FORMAT_HTML]

setTextFormat

public YouTube.Comments.List setTextFormat(String textFormat)

This parameter indicates whether the API should return comments formatted as HTML or as plain text.

set

public YouTube.Comments.List set(String parameterName,
                                 Object value)

Overrides:

set in class YouTubeRequest<CommentListResponse>