drive  v3
Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Drive.v3.FilesResource.GetRequest Class Reference

Gets a file's metadata or content by ID. More...

Inheritance diagram for Google.Apis.Drive.v3.FilesResource.GetRequest:
Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.File >

Public Member Functions

 GetRequest (Google.Apis.Services.IClientService service, string fileId)
 Constructs a new Get request. More...
 
virtual void Download (System.IO.Stream stream)
 Synchronously download the media into the given stream. More...
 
virtual System.Threading.Tasks.Task< Google.Apis.Download.IDownloadProgressDownloadAsync (System.IO.Stream stream)
 Asynchronously download the media into the given stream. More...
 
virtual System.Threading.Tasks.Task< Google.Apis.Download.IDownloadProgressDownloadAsync (System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
 Asynchronously download the media into the given stream. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes Get parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.File >
 DriveBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new DriveBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Drive parameter list. More...
 

Properties

virtual string FileId [get]
 The ID of the file. More...
 
virtual System.Nullable< bool > AcknowledgeAbuse [get, set]
 Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. More...
 
virtual System.Nullable< bool > SupportsAllDrives [get, set]
 Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. More...
 
virtual System.Nullable< bool > SupportsTeamDrives [get, set]
 Deprecated use supportsAllDrives instead. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
Google.Apis.Download.IMediaDownloader MediaDownloader [get]
 Gets the media downloader. More...
 
- Properties inherited from Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.File >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 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. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Gets a file's metadata or content by ID.

Constructor & Destructor Documentation

◆ GetRequest()

Google.Apis.Drive.v3.FilesResource.GetRequest.GetRequest ( Google.Apis.Services.IClientService  service,
string  fileId 
)
inline

Constructs a new Get request.

Member Function Documentation

◆ Download()

virtual void Google.Apis.Drive.v3.FilesResource.GetRequest.Download ( System.IO.Stream  stream)
inlinevirtual

Synchronously download the media into the given stream.

◆ DownloadAsync() [1/2]

virtual System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress> Google.Apis.Drive.v3.FilesResource.GetRequest.DownloadAsync ( System.IO.Stream  stream)
inlinevirtual

Asynchronously download the media into the given stream.

◆ DownloadAsync() [2/2]

virtual System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress> Google.Apis.Drive.v3.FilesResource.GetRequest.DownloadAsync ( System.IO.Stream  stream,
System.Threading.CancellationToken  cancellationToken 
)
inlinevirtual

Asynchronously download the media into the given stream.

◆ InitParameters()

override void Google.Apis.Drive.v3.FilesResource.GetRequest.InitParameters ( )
inlineprotected

Initializes Get parameter list.

Property Documentation

◆ AcknowledgeAbuse

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.GetRequest.AcknowledgeAbuse
getset

Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.

[default: false]

◆ FileId

virtual string Google.Apis.Drive.v3.FilesResource.GetRequest.FileId
get

The ID of the file.

◆ HttpMethod

override string Google.Apis.Drive.v3.FilesResource.GetRequest.HttpMethod
get

summary>Gets the REST path.

◆ MediaDownloader

Google.Apis.Download.IMediaDownloader Google.Apis.Drive.v3.FilesResource.GetRequest.MediaDownloader
get

Gets the media downloader.

◆ MethodName

override string Google.Apis.Drive.v3.FilesResource.GetRequest.MethodName
get

summary>Gets the HTTP method.

◆ SupportsAllDrives

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.GetRequest.SupportsAllDrives
getset

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

[default: false]

◆ SupportsTeamDrives

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.GetRequest.SupportsTeamDrives
getset

Deprecated use supportsAllDrives instead.

[default: false] summary>Gets the method name.


The documentation for this class was generated from the following file: