Class FilesResource.GetRequest

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 instead. For more information, see Download & export files.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<File>
DriveBaseServiceRequest<File>
FilesResource.GetRequest
Implements
Inherited Members
Namespace: Google.Apis.Drive.v2
Assembly: Google.Apis.Drive.v2.dll
Syntax
public class FilesResource.GetRequest : DriveBaseServiceRequest<File>, IClientServiceRequest<File>, IClientServiceRequest

Constructors

GetRequest(IClientService, string)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string fileId)
Parameters
Type Name Description
IClientService service
string fileId

Properties

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.

Declaration
[RequestParameter("acknowledgeAbuse", RequestParameterType.Query)]
public virtual bool? AcknowledgeAbuse { get; set; }
Property Value
Type Description
bool?

FileId

The ID for the file in question.

Declaration
[RequestParameter("fileId", RequestParameterType.Path)]
public virtual string FileId { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

IncludeLabels

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

Declaration
[RequestParameter("includeLabels", RequestParameterType.Query)]
public virtual string IncludeLabels { get; set; }
Property Value
Type Description
string

IncludePermissionsForView

Specifies which additional view's permissions to include in the response. Only published is supported.

Declaration
[RequestParameter("includePermissionsForView", RequestParameterType.Query)]
public virtual string IncludePermissionsForView { get; set; }
Property Value
Type Description
string

MediaDownloader

Gets the media downloader.

Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
Type Description
IMediaDownloader

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Projection

Deprecated: This parameter has no function.

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual FilesResource.GetRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
FilesResource.GetRequest.ProjectionEnum?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

RevisionId

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

Declaration
[RequestParameter("revisionId", RequestParameterType.Query)]
public virtual string RevisionId { get; set; }
Property Value
Type Description
string

SupportsAllDrives

Whether the requesting application supports both My Drives and shared drives.

Declaration
[RequestParameter("supportsAllDrives", RequestParameterType.Query)]
public virtual bool? SupportsAllDrives { get; set; }
Property Value
Type Description
bool?

SupportsTeamDrives

Deprecated: Use supportsAllDrives instead.

Declaration
[RequestParameter("supportsTeamDrives", RequestParameterType.Query)]
public virtual bool? SupportsTeamDrives { get; set; }
Property Value
Type Description
bool?

UpdateViewedDate

Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Declaration
[RequestParameter("updateViewedDate", RequestParameterType.Query)]
public virtual bool? UpdateViewedDate { get; set; }
Property Value
Type Description
bool?

Methods

Download(Stream)

Synchronously download the media into the given stream.

Warning: This method hides download errors; use DownloadWithStatus(Stream) instead.

Declaration
public virtual void Download(Stream stream)
Parameters
Type Name Description
Stream stream
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadAsync(Stream)

Asynchronously download the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream)
Parameters
Type Name Description
Stream stream
Returns
Type Description
Task<IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadAsync(Stream, CancellationToken)

Asynchronously download the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream, CancellationToken cancellationToken)
Parameters
Type Name Description
Stream stream
CancellationToken cancellationToken
Returns
Type Description
Task<IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRange(Stream, RangeHeaderValue)

Synchronously download a range of the media into the given stream.

Declaration
public virtual IDownloadProgress DownloadRange(Stream stream, RangeHeaderValue range)
Parameters
Type Name Description
Stream stream
RangeHeaderValue range
Returns
Type Description
IDownloadProgress
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRangeAsync(Stream, RangeHeaderValue, CancellationToken)

Asynchronously download a range of the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadRangeAsync(Stream stream, RangeHeaderValue range, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Stream stream
RangeHeaderValue range
CancellationToken cancellationToken
Returns
Type Description
Task<IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadWithStatus(Stream)

Synchronously download the media into the given stream.

Declaration
public virtual IDownloadProgress DownloadWithStatus(Stream stream)
Parameters
Type Name Description
Stream stream
Returns
Type Description
IDownloadProgress

The final status of the download; including whether the download succeeded or failed.
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements