Class MediaResource.DownloadRequest
Download a file attached to a case. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL:
shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header
"Authorization: Bearer $(gcloud auth print-access-token)" \
"https://cloudsupport.googleapis.com/v2/$name:download?alt=media"
Python:
python import
googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build(
serviceName="cloudsupport", version=api_version,
discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request
= supportApiService.media().download(
name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri =
request.uri.split("?")[0] + "?alt=media" print(request.execute())
Inheritance
Inherited Members
Namespace: Google.Apis.CloudSupport.v2
Assembly: Google.Apis.CloudSupport.v2.dll
Syntax
public class MediaResource.DownloadRequest : CloudSupportBaseServiceRequest<Media>, IClientServiceRequest<Media>, IClientServiceRequest
Constructors
DownloadRequest(IClientService, string)
Constructs a new Download request.
Declaration
public DownloadRequest(IClientService service, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | name |
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
Name
The name of the file attachment to download.
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { 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 Download parameter list.
Declaration
protected override void InitParameters()