Drive.Comments.List (Google Drive API v3-rev20241027-2.0.0)

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.drive.DriveRequest<CommentList>
        
        com.google.api.services.drive.Drive.Comments.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Comments
```
public class Drive.Comments.List
extends DriveRequest<CommentList>
```

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>
- 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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String fileId)
Lists a file's comments.

Constructors
Modifier	Constructor and Description
`protected`	`List(String fileId)` Lists a file's comments.

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`	`getFileId()` The ID of the file.
`Boolean`	`getIncludeDeleted()` Whether to include deleted comments.
`Integer`	`getPageSize()` The maximum number of comments to return per page.
`String`	`getPageToken()` The token for continuing a previous list request on the next page.
`String`	`getStartModifiedTime()` The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
`boolean`	`isIncludeDeleted()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`Drive.Comments.List`	`set(String parameterName, Object value)`
`Drive.Comments.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`Drive.Comments.List`	`setAccessToken(String accessToken)` OAuth access token.
`Drive.Comments.List`	`setAlt(String alt)` Data format for response.
`Drive.Comments.List`	`setCallback(String callback)` JSONP
`Drive.Comments.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Drive.Comments.List`	`setFileId(String fileId)` The ID of the file.
`Drive.Comments.List`	`setIncludeDeleted(Boolean includeDeleted)` Whether to include deleted comments.
`Drive.Comments.List`	`setKey(String key)` API key.
`Drive.Comments.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Comments.List`	`setPageSize(Integer pageSize)` The maximum number of comments to return per page.
`Drive.Comments.List`	`setPageToken(String pageToken)` The token for continuing a previous list request on the next page.
`Drive.Comments.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Comments.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Drive.Comments.List`	`setStartModifiedTime(String startModifiedTime)` The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
`Drive.Comments.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`Drive.Comments.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.drive.DriveRequest
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(String fileId)
```
    Lists a file's comments. Create a request for the method "comments.list". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    fileId - The ID of the file.
    
    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<CommentList>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<CommentList>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public Drive.Comments.List set$Xgafv(String $Xgafv)
```
    Description copied from class: DriveRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DriveRequest<CommentList>
  - setAccessToken
```
public Drive.Comments.List setAccessToken(String accessToken)
```
    Description copied from class: DriveRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DriveRequest<CommentList>
  - setAlt
```
public Drive.Comments.List setAlt(String alt)
```
    Description copied from class: DriveRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DriveRequest<CommentList>
  - setCallback
```
public Drive.Comments.List setCallback(String callback)
```
    Description copied from class: DriveRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DriveRequest<CommentList>
  - setFields
```
public Drive.Comments.List setFields(String fields)
```
    Description copied from class: DriveRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DriveRequest<CommentList>
  - setKey
```
public Drive.Comments.List setKey(String key)
```
    Description copied from class: DriveRequest
    
    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 DriveRequest<CommentList>
  - setOauthToken
```
public Drive.Comments.List setOauthToken(String oauthToken)
```
    Description copied from class: DriveRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DriveRequest<CommentList>
  - setPrettyPrint
```
public Drive.Comments.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: DriveRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DriveRequest<CommentList>
  - setQuotaUser
```
public Drive.Comments.List setQuotaUser(String quotaUser)
```
    Description copied from class: DriveRequest
    
    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 DriveRequest<CommentList>
  - setUploadType
```
public Drive.Comments.List setUploadType(String uploadType)
```
    Description copied from class: DriveRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DriveRequest<CommentList>
  - setUploadProtocol
```
public Drive.Comments.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: DriveRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DriveRequest<CommentList>
  - getFileId
```
public String getFileId()
```
    The ID of the file.
  - setFileId
```
public Drive.Comments.List setFileId(String fileId)
```
    The ID of the file.
  - getIncludeDeleted
```
public Boolean getIncludeDeleted()
```
    Whether to include deleted comments. Deleted comments will not include their original content. [default: false]
  - setIncludeDeleted
```
public Drive.Comments.List setIncludeDeleted(Boolean includeDeleted)
```
    Whether to include deleted comments. Deleted comments will not include their original content.
  - isIncludeDeleted
```
public boolean isIncludeDeleted()
```
    Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
    Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.
    
    This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.
    
    Whether to include deleted comments. Deleted comments will not include their original content.
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of comments to return per page. [default: 20] [minimum: 1] [maximum: 100]
  - setPageSize
```
public Drive.Comments.List setPageSize(Integer pageSize)
```
    The maximum number of comments to return per page.
  - getPageToken
```
public String getPageToken()
```
    The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  - setPageToken
```
public Drive.Comments.List setPageToken(String pageToken)
```
    The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
  - getStartModifiedTime
```
public String getStartModifiedTime()
```
    The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
  - setStartModifiedTime
```
public Drive.Comments.List setStartModifiedTime(String startModifiedTime)
```
    The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
  - set
```
public Drive.Comments.List set(String parameterName,
                               Object value)
```
    Overrides:
    
    set in class DriveRequest<CommentList>

Class Drive.Comments.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.drive.DriveRequest

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getFileId

setFileId

getIncludeDeleted

setIncludeDeleted

isIncludeDeleted

getPageSize

setPageSize

getPageToken

setPageToken

getStartModifiedTime

setStartModifiedTime

set