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>

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

Constructors

Modifier	Constructor and Description
protected	Drive.Files.Get(String fileId) Gets a file's metadata by ID.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
HttpResponse	executeUsingHead()
Boolean	getAcknowledgeAbuse() Whether the user is acknowledging the risk of downloading known malware or other abusive files.
String	getFileId() The ID for the file in question.
String	getProjection() This parameter is deprecated and has no function.
String	getRevisionId() Specifies the Revision ID that should be downloaded.
Boolean	getUpdateViewedDate() Whether to update the view date after successfully retrieving the file.
boolean	isAcknowledgeAbuse() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUpdateViewedDate() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Get	set(String parameterName, Object value)
Drive.Files.Get	setAcknowledgeAbuse(Boolean acknowledgeAbuse) Whether the user is acknowledging the risk of downloading known malware or other abusive files.
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	setFileId(String fileId) 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	setRevisionId(String revisionId) Specifies the Revision ID that should be downloaded.
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, checkRequiredParameter, 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, 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 fileId)

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(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

fileId - The ID for the file in question.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

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

setAlt

public Drive.Files.Get setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<File>

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

setKey

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

setOauthToken

public Drive.Files.Get setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<File>

setPrettyPrint

public Drive.Files.Get setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<File>

setQuotaUser

public Drive.Files.Get 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 userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<File>

setUserIp

public Drive.Files.Get setUserIp(String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<File>

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.

getProjection

public String getProjection()

This parameter is deprecated and has no function.

setProjection

public Drive.Files.Get setProjection(String projection)

This parameter is deprecated and has no function.

getRevisionId

public String getRevisionId()

Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

setRevisionId

public Drive.Files.Get setRevisionId(String revisionId)

Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

getAcknowledgeAbuse

public Boolean getAcknowledgeAbuse()

Whether the user is acknowledging the risk of downloading known malware or other abusive files. Ignored unless alt=media is specified. [default: false]

setAcknowledgeAbuse

public Drive.Files.Get setAcknowledgeAbuse(Boolean acknowledgeAbuse)

Whether the user is acknowledging the risk of downloading known malware or other abusive files. Ignored unless alt=media is specified.

isAcknowledgeAbuse

public boolean isAcknowledgeAbuse()

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 the user is acknowledging the risk of downloading known malware or other abusive files. Ignored unless alt=media is specified.

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.

set

public Drive.Files.Get set(String parameterName,
                  Object value)

Overrides:

set in class DriveRequest<File>