Drive API v2 (revision 1)

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

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.http.json.JsonHttpRequest
              com.google.api.services.drive.DriveRequest
                  com.google.api.services.drive.Drive.Files.Get

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.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

void	download(OutputStream outputStream)
File	execute() Sends the "get" request to the Drive server.
InputStream	executeAsMedia() Deprecated. (scheduled to be removed in 1.7) Use download(java.io.OutputStream) to write to an output stream. If the downloaded stream needs to be parsed request.setAlt("media").executeAsInputStream() can be used instead.
String	getFileId() The ID for the file in question.
MediaHttpDownloader	getMediaHttpDownloader() Returns the Media HTTP downloader.
String	getProjection() Restrict information returned for simplicity and optimization.
Boolean	getUpdateViewedDate() Whether to update the view date after successfully retrieving the file.
boolean	isUpdateViewedDate() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
void	queue(BatchRequest batch, JsonBatchCallback<File> callback) Queues the "get" request to the Drive server into the given batch request.
Drive.Files.Get	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Get	setFileId(String fileId) The ID for the file in question.
Drive.Files.Get	setProjection(String projection) Restrict information returned for simplicity and optimization.
Drive.Files.Get	setUpdateViewedDate(Boolean updateViewedDate) Whether to update the view date after successfully retrieving the file.

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, 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 File execute()
             throws IOException

Sends the "get" request to the Drive server.

Returns:

the File response

Throws:

IOException - if the request fails

executeAsMedia

@Deprecated
public InputStream executeAsMedia()
                           throws IOException

Deprecated. (scheduled to be removed in 1.7) Use download(java.io.OutputStream) to write to an output stream. If the downloaded stream needs to be parsed request.setAlt("media").executeAsInputStream() can be used instead.

Sends the "get" request to the Drive server and returns the input stream of the downloaded media content.

Callers are responsible for closing the input stream.

Returns:

the input stream of the downloaded media content

Throws:

IOException - if the request fails

download

public void download(OutputStream outputStream)
              throws IOException

Overrides:

download in class JsonHttpRequest

Throws:

IOException

Since:

1.6

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<File> callback)
           throws IOException

Queues the "get" request to the Drive server into the given batch request.

Example usage:

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

           public void onSuccess(File 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.Files.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

getFileId

public String getFileId()

The ID for the file in question.

setFileId

public Drive.Files.Get setFileId(String fileId)

The ID for the file in question.

getUpdateViewedDate

public Boolean getUpdateViewedDate()

Whether to update the view date after successfully retrieving the file. [default: false]

setUpdateViewedDate

public Drive.Files.Get setUpdateViewedDate(Boolean updateViewedDate)

Whether to update the view date after successfully retrieving the file.

isUpdateViewedDate

public boolean isUpdateViewedDate()

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 update the view date after successfully retrieving the file.

getProjection

public String getProjection()

Restrict information returned for simplicity and optimization.

setProjection

public Drive.Files.Get setProjection(String projection)

Restrict information returned for simplicity and optimization.

getMediaHttpDownloader

public MediaHttpDownloader getMediaHttpDownloader()

Returns the Media HTTP downloader.

Since:

1.6