Class FilesResource.GetRequest
Retrieves a report file by its report ID and file ID. This method supports media download.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_4
Assembly: Google.Apis.Dfareporting.v3_4.dll
Syntax
public class GetRequest : DfareportingBaseServiceRequest<File>, IClientServiceRequest<File>, IClientServiceRequestConstructors
GetRequest(IClientService, Int64, Int64)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, long reportId, long fileId)Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service | |
| System.Int64 | reportId | |
| System.Int64 | fileId |
Properties
FileId
The ID of the report file.
Declaration
[RequestParameter("fileId", RequestParameterType.Path)]
public virtual long FileId { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MediaDownloader
Gets the media downloader.
Declaration
public IMediaDownloader MediaDownloader { get; }Property Value
| Type | Description |
|---|---|
| Google.Apis.Download.IMediaDownloader |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
ReportId
The ID of the report.
Declaration
[RequestParameter("reportId", RequestParameterType.Path)]
public virtual long ReportId { get; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
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 |
|---|---|---|
| System.IO.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 |
|---|---|---|
| System.IO.Stream | stream |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Apis.Download.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 |
|---|---|---|
| System.IO.Stream | stream | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Apis.Download.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 |
|---|---|---|
| System.IO.Stream | stream | |
| System.Net.Http.Headers.RangeHeaderValue | range |
Returns
| Type | Description |
|---|---|
| Google.Apis.Download.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(CancellationToken))Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | stream | |
| System.Net.Http.Headers.RangeHeaderValue | range | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Google.Apis.Download.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 |
|---|---|---|
| System.IO.Stream | stream |
Returns
| Type | Description |
|---|---|
| Google.Apis.Download.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()