Drive API v1 (revision 55)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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.googleapis.services.AbstractGoogleClientRequest<T>
              com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  com.google.api.services.drive.DriveRequest<File>
                      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<File>
extends DriveRequest<File>

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>`

Constructor Summary
`protected`	`Drive.Files.Get(String id)` Gets a file's metadata by id.

Method Summary
`HttpRequest`	`buildHttpRequestUsingHead()`
`HttpResponse`	`executeMedia()`
`void`	`executeMediaAndDownloadTo(OutputStream outputStream)` Upgrade warning: in prior version 1.8 this method was called `download`.
`InputStream`	`executeMediaAsInputStream()`
`HttpResponse`	`executeUsingHead()`
`String`	`getId()` The id for the file in question.
`String`	`getProjection()` This parameter is deprecated and has no function.
`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`.
`Drive.Files.Get`	`setAlt(String alt)` Data format for the response.
`Drive.Files.Get`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Drive.Files.Get`	`setId(String id)` The id for the file in question.
`Drive.Files.Get`	`setKey(String key)` API key.
`Drive.Files.Get`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Drive.Files.Get`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Drive.Files.Get`	`setProjection(String projection)` This parameter is deprecated and has no function.
`Drive.Files.Get`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`Drive.Files.Get`	`setUpdateViewedDate(Boolean updateViewedDate)` Whether to update the view date after successfully retrieving the file.
`Drive.Files.Get`	`setUserIp(String userIp)` IP address of the site where the request originates.

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, execute, executeAndDownloadTo, executeAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue`

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`

Constructor Detail

Drive.Files.Get

protected Drive.Files.Get(String id)

Gets a file's metadata by id. Create a request for the method "files.get". 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(AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:: id - The id for the file in question.
Since:: 1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Upgrade warning: in prior version 1.8 this method was called download.

Overrides:: executeMediaAndDownloadTo in class AbstractGoogleClientRequest<File>

Throws:: IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:: executeMediaAsInputStream in class AbstractGoogleClientRequest<File>

Throws:: IOException

executeMedia

public HttpResponse executeMedia()
                          throws IOException

Overrides:: executeMedia in class AbstractGoogleClientRequest<File>

Throws:: IOException

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:: executeUsingHead in class AbstractGoogleClientRequest<File>

Throws:: IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:: buildHttpRequestUsingHead in class AbstractGoogleClientRequest<File>

Throws:: IOException