target.apidocs.com.google.api.services.youtube.YouTube.CommentThreads.List.html Maven / Gradle / Ivy
YouTube.CommentThreads.List (YouTube Data API v3 v3-rev20240417-2.0.0)
com.google.api.services.youtube
Class YouTube.CommentThreads.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<CommentThreadListResponse>
-
- com.google.api.services.youtube.YouTube.CommentThreads.List
-
- Enclosing class:
- YouTube.CommentThreads
public class YouTube.CommentThreads.List
extends YouTubeRequest<CommentThreadListResponse>
-
-
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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
List(List<String> part)
Retrieves a list of resources, possibly filtered.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getAllThreadsRelatedToChannelId()
Returns the comment threads of all videos of the channel and the channel comments as well.
String
getChannelId()
Returns the comment threads for all the channel comments (ie does not include comments left on
videos).
List<String>
getId()
Returns the comment threads with the given IDs for Stubby or Apiary.
Long
getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
result set.
String
getModerationStatus()
Limits the returned comment threads to those with the specified moderation status.
String
getOrder()
[ default: time]
[
String
getPageToken()
The *pageToken* parameter identifies a specific page in the result set that should be returned.
List<String>
getPart()
The *part* parameter specifies a comma-separated list of one or more commentThread resource
properties that the API response will include.
String
getSearchTerms()
Limits the returned comment threads to those matching the specified key words.
String
getTextFormat()
The requested text format for the returned comments.
String
getVideoId()
Returns the comment threads of the specified video.
YouTube.CommentThreads.List
set(String parameterName,
Object value)
YouTube.CommentThreads.List
set$Xgafv(String $Xgafv)
V1 error format.
YouTube.CommentThreads.List
setAccessToken(String accessToken)
OAuth access token.
YouTube.CommentThreads.List
setAllThreadsRelatedToChannelId(String allThreadsRelatedToChannelId)
Returns the comment threads of all videos of the channel and the channel comments as well.
YouTube.CommentThreads.List
setAlt(String alt)
Data format for response.
YouTube.CommentThreads.List
setCallback(String callback)
JSONP
YouTube.CommentThreads.List
setChannelId(String channelId)
Returns the comment threads for all the channel comments (ie does not include comments left
on videos).
YouTube.CommentThreads.List
setFields(String fields)
Selector specifying which fields to include in a partial response.
YouTube.CommentThreads.List
setId(List<String> id)
Returns the comment threads with the given IDs for Stubby or Apiary.
YouTube.CommentThreads.List
setKey(String key)
API key.
YouTube.CommentThreads.List
setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
the result set.
YouTube.CommentThreads.List
setModerationStatus(String moderationStatus)
Limits the returned comment threads to those with the specified moderation status.
YouTube.CommentThreads.List
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
YouTube.CommentThreads.List
setOrder(String order)
YouTube.CommentThreads.List
setPageToken(String pageToken)
The *pageToken* parameter identifies a specific page in the result set that should be
returned.
YouTube.CommentThreads.List
setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more commentThread resource
properties that the API response will include.
YouTube.CommentThreads.List
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
YouTube.CommentThreads.List
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
YouTube.CommentThreads.List
setSearchTerms(String searchTerms)
Limits the returned comment threads to those matching the specified key words.
YouTube.CommentThreads.List
setTextFormat(String textFormat)
The requested text format for the returned comments.
YouTube.CommentThreads.List
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
YouTube.CommentThreads.List
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
YouTube.CommentThreads.List
setVideoId(String videoId)
Returns the comment threads of the specified video.
-
Methods inherited from class com.google.api.services.youtube.YouTubeRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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(List<String> part)
Retrieves a list of resources, possibly filtered.
Create a request for the method "commentThreads.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 commentThread resource
properties that the API response will include.
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentThreadListResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentThreadListResponse>
- Throws:
IOException
-
set$Xgafv
public YouTube.CommentThreads.List set$Xgafv(String $Xgafv)
Description copied from class: YouTubeRequest
V1 error format.
- Overrides:
set$Xgafv
in class YouTubeRequest<CommentThreadListResponse>
-
setAccessToken
public YouTube.CommentThreads.List setAccessToken(String accessToken)
Description copied from class: YouTubeRequest
OAuth access token.
- Overrides:
setAccessToken
in class YouTubeRequest<CommentThreadListResponse>
-
setAlt
public YouTube.CommentThreads.List setAlt(String alt)
Description copied from class: YouTubeRequest
Data format for response.
- Overrides:
setAlt
in class YouTubeRequest<CommentThreadListResponse>
-
setCallback
public YouTube.CommentThreads.List setCallback(String callback)
Description copied from class: YouTubeRequest
JSONP
- Overrides:
setCallback
in class YouTubeRequest<CommentThreadListResponse>
-
setFields
public YouTube.CommentThreads.List setFields(String fields)
Description copied from class: YouTubeRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class YouTubeRequest<CommentThreadListResponse>
-
setKey
public YouTube.CommentThreads.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<CommentThreadListResponse>
-
setOauthToken
public YouTube.CommentThreads.List setOauthToken(String oauthToken)
Description copied from class: YouTubeRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class YouTubeRequest<CommentThreadListResponse>
-
setPrettyPrint
public YouTube.CommentThreads.List setPrettyPrint(Boolean prettyPrint)
Description copied from class: YouTubeRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class YouTubeRequest<CommentThreadListResponse>
-
setQuotaUser
public YouTube.CommentThreads.List setQuotaUser(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:
setQuotaUser
in class YouTubeRequest<CommentThreadListResponse>
-
setUploadType
public YouTube.CommentThreads.List setUploadType(String uploadType)
Description copied from class: YouTubeRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class YouTubeRequest<CommentThreadListResponse>
-
setUploadProtocol
public YouTube.CommentThreads.List setUploadProtocol(String uploadProtocol)
Description copied from class: YouTubeRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class YouTubeRequest<CommentThreadListResponse>
-
getPart
public List<String> getPart()
The *part* parameter specifies a comma-separated list of one or more commentThread resource
properties that the API response will include.
-
setPart
public YouTube.CommentThreads.List setPart(List<String> part)
The *part* parameter specifies a comma-separated list of one or more commentThread resource
properties that the API response will include.
-
getAllThreadsRelatedToChannelId
public String getAllThreadsRelatedToChannelId()
Returns the comment threads of all videos of the channel and the channel comments as well.
-
setAllThreadsRelatedToChannelId
public YouTube.CommentThreads.List setAllThreadsRelatedToChannelId(String allThreadsRelatedToChannelId)
Returns the comment threads of all videos of the channel and the channel comments as well.
-
getChannelId
public String getChannelId()
Returns the comment threads for all the channel comments (ie does not include comments left on
videos).
-
setChannelId
public YouTube.CommentThreads.List setChannelId(String channelId)
Returns the comment threads for all the channel comments (ie does not include comments left
on videos).
-
getId
public List<String> getId()
Returns the comment threads with the given IDs for Stubby or Apiary.
-
setId
public YouTube.CommentThreads.List setId(List<String> id)
Returns the comment threads with the given IDs for Stubby or Apiary.
-
getMaxResults
public Long getMaxResults()
The *maxResults* parameter specifies the maximum number of items that should be returned in the
result set. [default: 20] [minimum: 1] [maximum: 100]
-
setMaxResults
public YouTube.CommentThreads.List setMaxResults(Long maxResults)
The *maxResults* parameter specifies the maximum number of items that should be returned in
the result set.
-
getModerationStatus
public String getModerationStatus()
Limits the returned comment threads to those with the specified moderation status. Not compatible
with the 'id' filter. Valid values: published, heldForReview, likelySpam. [default: published]
-
setModerationStatus
public YouTube.CommentThreads.List setModerationStatus(String moderationStatus)
Limits the returned comment threads to those with the specified moderation status. Not
compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.
-
getOrder
public String getOrder()
[ default: time]
[
-
setOrder
public YouTube.CommentThreads.List setOrder(String order)
-
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 and prevPageToken properties identify other pages that could be
retrieved.
-
setPageToken
public YouTube.CommentThreads.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 and prevPageToken properties identify other
pages that could be retrieved.
-
getSearchTerms
public String getSearchTerms()
Limits the returned comment threads to those matching the specified key words. Not compatible with
the 'id' filter.
-
setSearchTerms
public YouTube.CommentThreads.List setSearchTerms(String searchTerms)
Limits the returned comment threads to those matching the specified key words. Not
compatible with the 'id' filter.
-
getTextFormat
public String getTextFormat()
The requested text format for the returned comments. [default: html]
-
setTextFormat
public YouTube.CommentThreads.List setTextFormat(String textFormat)
The requested text format for the returned comments.
-
getVideoId
public String getVideoId()
Returns the comment threads of the specified video.
-
setVideoId
public YouTube.CommentThreads.List setVideoId(String videoId)
Returns the comment threads of the specified video.
-
set
public YouTube.CommentThreads.List set(String parameterName,
Object value)
- Overrides:
set
in class YouTubeRequest<CommentThreadListResponse>
Copyright © 2011–2024 Google. All rights reserved.