Class ReportsResource.GetFileRequest

Downloads a report file encoded in UTF-8.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<string>
DoubleclicksearchBaseServiceRequest<string>
ReportsResource.GetFileRequest
Implements
Inherited Members
Namespace: Google.Apis.Doubleclicksearch.v2
Assembly: Google.Apis.Doubleclicksearch.v2.dll
Syntax
public class ReportsResource.GetFileRequest : DoubleclicksearchBaseServiceRequest<string>, IClientServiceRequest<string>, IClientServiceRequest

Constructors

GetFileRequest(IClientService, string, int)

Constructs a new GetFile request.

Declaration
public GetFileRequest(IClientService service, string reportId, int reportFragment)
Parameters
Type Name Description
IClientService service
string reportId
int reportFragment

Properties

HttpMethod

Gets the HTTP method.

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

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

ReportFragment

The index of the report fragment to download.

Declaration
[RequestParameter("reportFragment", RequestParameterType.Path)]
public virtual int ReportFragment { get; }
Property Value
Type Description
int

ReportId

ID of the report.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
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
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 GetFile parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements