Drive.Comments.List (Drive API v2-rev20230514-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
  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()` If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
`Integer`	`getMaxResults()` The maximum number of discussions to include in the response, used for paging.
`String`	`getPageToken()` The continuation token, used to page through large result sets.
`String`	`getUpdatedMin()` Only discussions that were updated after this timestamp will be returned.
`boolean`	`isIncludeDeleted()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`Drive.Comments.List`	`set(String parameterName, Object value)`
`Drive.Comments.List`	`setAlt(String alt)` Data format for the response.
`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)` If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
`Drive.Comments.List`	`setKey(String key)` API key.
`Drive.Comments.List`	`setMaxResults(Integer maxResults)` The maximum number of discussions to include in the response, used for paging.
`Drive.Comments.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Comments.List`	`setPageToken(String pageToken)` The continuation token, used to page through large result sets.
`Drive.Comments.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Comments.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Drive.Comments.List`	`setUpdatedMin(String updatedMin)` Only discussions that were updated after this timestamp will be returned.
`Drive.Comments.List`	`setUserIp(String userIp)` Deprecated.

Methods inherited from class com.google.api.services.drive.DriveRequest
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 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
  - setAlt
```
public Drive.Comments.List setAlt(String alt)
```
    Description copied from class: DriveRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt 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
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class DriveRequest<CommentList>
  - setUserIp
```
public Drive.Comments.List setUserIp(String userIp)
```
    Description copied from class: DriveRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp 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()
```
    If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned. [default: false]
  - setIncludeDeleted
```
public Drive.Comments.List setIncludeDeleted(Boolean includeDeleted)
```
    If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
  - 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.
    
    If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of discussions to include in the response, used for paging. [default: 20] [minimum: 0] [maximum: 100]
  - setMaxResults
```
public Drive.Comments.List setMaxResults(Integer maxResults)
```
    The maximum number of discussions to include in the response, used for paging.
  - getPageToken
```
public String getPageToken()
```
    The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
  - setPageToken
```
public Drive.Comments.List setPageToken(String pageToken)
```
    The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.
  - getUpdatedMin
```
public String getUpdatedMin()
```
    Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
  - setUpdatedMin
```
public Drive.Comments.List setUpdatedMin(String updatedMin)
```
    Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.
  - 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

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getFileId

setFileId

getIncludeDeleted

setIncludeDeleted

isIncludeDeleted

getMaxResults

setMaxResults

getPageToken

setPageToken

getUpdatedMin

setUpdatedMin

set