• Home
• com.google.apis
• google-api-services-drive
• v3-rev20241027-2.0.0
• source code
• Drive.Files.Get.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.drive.Drive.Files.Get.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






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>











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
API_VERSION_HEADER, USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Get(String fileId)
Gets a file's metadata or content by ID.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


com.google.api.client.http.GenericUrl
buildHttpRequestUrl() 


com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead() 


com.google.api.client.http.HttpResponse
executeMedia() 


void
executeMediaAndDownloadTo(OutputStream outputStream) 


InputStream
executeMediaAsInputStream() 


com.google.api.client.http.HttpResponse
executeUsingHead() 


Boolean
getAcknowledgeAbuse()
Whether the user is acknowledging the risk of downloading known malware or other abusive files.



String
getFileId()
The ID of the file.



String
getIncludeLabels()
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.



String
getIncludePermissionsForView()
Specifies which additional view's permissions to include in the response.



Boolean
getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives.



Boolean
getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead.



boolean
isAcknowledgeAbuse()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isSupportsAllDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



boolean
isSupportsTeamDrives()
Convenience method that returns only Boolean.TRUE or Boolean.FALSE.



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


Drive.Files.Get
set$Xgafv(String $Xgafv)
V1 error format.



Drive.Files.Get
setAccessToken(String accessToken)
OAuth access token.



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 response.



Drive.Files.Get
setCallback(String callback)
JSONP



Drive.Files.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.



Drive.Files.Get
setFileId(String fileId)
The ID of the file.



Drive.Files.Get
setIncludeLabels(String includeLabels)
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.



Drive.Files.Get
setIncludePermissionsForView(String includePermissionsForView)
Specifies which additional view's permissions to include in the response.



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
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Drive.Files.Get
setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.



Drive.Files.Get
setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.



Drive.Files.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Drive.Files.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.







Methods inherited from class com.google.api.services.drive.DriveRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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





Get
protected Get(String fileId)
Gets a file's metadata or content by ID. If you provide the URL parameter `alt=media`, then the
 response includes the file contents in the response body. Downloading content with `alt=media`
 only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use
 [`files.export`](/drive/api/reference/rest/v3/files/export) instead. For more information, see
 [Download & export files](/drive/api/guides/manage-downloads).

 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 of the file.
Since:
1.13










Method Detail





executeMediaAndDownloadTo
public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:
executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
Throws:
IOException








executeMediaAsInputStream
public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:
executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
Throws:
IOException








executeMedia
public com.google.api.client.http.HttpResponse executeMedia()
                                                     throws IOException

Overrides:
executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
Throws:
IOException








buildHttpRequestUrl
public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:
buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>








executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
Throws:
IOException








buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<File>
Throws:
IOException








set$Xgafv
public Drive.Files.Get set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.

Overrides:
set$Xgafv in class DriveRequest<File>








setAccessToken
public Drive.Files.Get setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.

Overrides:
setAccessToken in class DriveRequest<File>








setAlt
public Drive.Files.Get setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.

Overrides:
setAlt in class DriveRequest<File>








setCallback
public Drive.Files.Get setCallback(String callback)
Description copied from class: DriveRequest
JSONP

Overrides:
setCallback 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:
setQuotaUser in class DriveRequest<File>








setUploadType
public Drive.Files.Get setUploadType(String uploadType)
Description copied from class: DriveRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class DriveRequest<File>








setUploadProtocol
public Drive.Files.Get setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DriveRequest<File>








getFileId
public String getFileId()
The ID of the file.







setFileId
public Drive.Files.Get setFileId(String fileId)
The ID of the file.







getAcknowledgeAbuse
public Boolean getAcknowledgeAbuse()
Whether the user is acknowledging the risk of downloading known malware or other abusive files.
     This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the
     file or an organizer of the shared drive in which the file resides. [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. This is only applicable when the `alt` parameter is set to `media` and the user is
 the owner of the file or an organizer of the shared drive in which the file resides.







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.
     This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the
     file or an organizer of the shared drive in which the file resides.
 







getIncludeLabels
public String getIncludeLabels()
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.







setIncludeLabels
public Drive.Files.Get setIncludeLabels(String includeLabels)
A comma-separated list of IDs of labels to include in the `labelInfo` part of the response.







getIncludePermissionsForView
public String getIncludePermissionsForView()
Specifies which additional view's permissions to include in the response. Only 'published' is
     supported.







setIncludePermissionsForView
public Drive.Files.Get setIncludePermissionsForView(String includePermissionsForView)
Specifies which additional view's permissions to include in the response. Only 'published'
 is supported.







getSupportsAllDrives
public Boolean getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives. [default: false]







setSupportsAllDrives
public Drive.Files.Get setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.







isSupportsAllDrives
public boolean isSupportsAllDrives()
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 requesting application supports both My Drives and shared drives.
 







getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead. [default: false]







setSupportsTeamDrives
public Drive.Files.Get setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.







isSupportsTeamDrives
public boolean isSupportsTeamDrives()
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.
 

 

 Deprecated: Use `supportsAllDrives` instead.
 







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

Overrides:
set in class DriveRequest<File>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.