Drive API v2 (revision 1)



com.google.api.services.drive
Class Drive.About.Get

java.lang.Object
  extended by java.util.AbstractMap<String,Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.http.json.JsonHttpRequest
              extended by com.google.api.services.drive.DriveRequest
                  extended by com.google.api.services.drive.Drive.About.Get
All Implemented Interfaces:
Cloneable, Map<String,Object>
Enclosing class:
Drive.About

public class Drive.About.Get
extends DriveRequest


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>
 
Method Summary
 About execute()
          Sends the "get" request to the Drive server.
 Boolean getIncludeSubscribed()
          Whether to include subscribed items when calculating the number of remaining change IDs [default: true]
 BigInteger getMaxChangeIdCount()
          Maximum number of remaining change IDs to count [default: 1]
 BigInteger getStartChangeId()
          Change ID to start counting from when calculating number of remaining change IDs
 boolean isIncludeSubscribed()
          Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
 void queue(BatchRequest batch, JsonBatchCallback<About> callback)
          Queues the "get" request to the Drive server into the given batch request.
 Drive.About.Get setFields(String fields)
          Selector specifying which fields to include in a partial response.
 Drive.About.Get setIncludeSubscribed(Boolean includeSubscribed)
          Whether to include subscribed items when calculating the number of remaining change IDs
 Drive.About.Get setMaxChangeIdCount(BigInteger maxChangeIdCount)
          Maximum number of remaining change IDs to count
 Drive.About.Get setStartChangeId(BigInteger startChangeId)
          Change ID to start counting from when calculating number of remaining change IDs
 
Methods inherited from class com.google.api.services.drive.DriveRequest
getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setAlt, setKey, setOauthToken, setPrettyPrint, setQuotaUser, setUserIp
 
Methods inherited from class com.google.api.client.http.json.JsonHttpRequest
buildHttpRequest, buildHttpRequestUrl, download, executeAsInputStream, executeUnparsed, getClient, getEnableGZipContent, getJsonContent, getLastResponseHeaders, getMethod, getRequestHeaders, getUriTemplate, setEnableGZipContent, setRequestHeaders
 
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, setUnknownKeys
 
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

execute

public About execute()
              throws IOException
Sends the "get" request to the Drive server.

Returns:
the About response
Throws:
IOException - if the request fails

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<About> callback)
           throws IOException
Queues the "get" request to the Drive server into the given batch request.

Example usage:

         request.queue(batchRequest, new JsonBatchCallback<About>() {

           public void onSuccess(About content, GoogleHeaders responseHeaders) {
             log("Success");
           }

           public void onFailure(GoogleJsonError e, GoogleHeaders responseHeaders) {
             log(e.getMessage());
           }
         });
 

Parameters:
batch - a single batch of requests
callback - batch callback
Throws:
IOException
Since:
1.6

setFields

public Drive.About.Get setFields(String fields)
Description copied from class: DriveRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class DriveRequest
Since:
1.7

getIncludeSubscribed

public Boolean getIncludeSubscribed()
Whether to include subscribed items when calculating the number of remaining change IDs [default: true]


setIncludeSubscribed

public Drive.About.Get setIncludeSubscribed(Boolean includeSubscribed)
Whether to include subscribed items when calculating the number of remaining change IDs


isIncludeSubscribed

public boolean isIncludeSubscribed()
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 subscribed items when calculating the number of remaining change IDs


getMaxChangeIdCount

public BigInteger getMaxChangeIdCount()
Maximum number of remaining change IDs to count [default: 1]


setMaxChangeIdCount

public Drive.About.Get setMaxChangeIdCount(BigInteger maxChangeIdCount)
Maximum number of remaining change IDs to count


getStartChangeId

public BigInteger getStartChangeId()
Change ID to start counting from when calculating number of remaining change IDs


setStartChangeId

public Drive.About.Get setStartChangeId(BigInteger startChangeId)
Change ID to start counting from when calculating number of remaining change IDs