Class ReportsResource.FilesResource.GetRequest
Retrieves a report file. This method supports media download.
Inheritance
System.Object
ReportsResource.FilesResource.GetRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Google.Apis.Dfareporting.v3_2.dll
Syntax
public class GetRequest : DfareportingBaseServiceRequest<File>, IClientServiceRequest<File>, IClientServiceRequest
Constructors
GetRequest(IClientService, Int64, Int64, Int64)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, long profileId, long reportId, long fileId)
Parameters
Type |
Name |
Description |
IClientService |
service |
|
System.Int64 |
profileId |
|
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
Declaration
public override string HttpMethod { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_2.Data.File>.HttpMethod
Gets the media downloader.
Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
MethodName
Declaration
public override string MethodName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_2.Data.File>.MethodName
ProfileId
Declaration
[RequestParameter("profileId", RequestParameterType.Path)]
public virtual long ProfileId { get; }
Property Value
Type |
Description |
System.Int64 |
|
ReportId
Declaration
[RequestParameter("reportId", RequestParameterType.Path)]
public virtual long ReportId { get; }
Property Value
Type |
Description |
System.Int64 |
|
RestPath
Declaration
public override string RestPath { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dfareporting.v3_2.Data.File>.RestPath
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 |
|
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
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
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
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
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 |
IDownloadProgress |
The final status of the download; including whether the download succeeded or failed.
|
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dfareporting.v3_2.DfareportingBaseServiceRequest<Google.Apis.Dfareporting.v3_2.Data.File>.InitParameters()
Implements