/
BlobDownloadOptions.cs
44 lines (39 loc) · 1.75 KB
/
BlobDownloadOptions.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
using System;
using Azure.Core;
namespace Azure.Storage.Blobs.Models
{
/// <summary>
/// Optional parameters for downloading a range of a blob.
/// </summary>
public class BlobDownloadOptions
{
/// <summary>
/// If provided, only download the bytes of the blob in the specified
/// range. If not provided, download the entire blob.
/// </summary>
public HttpRange Range { get; set; }
/// <summary>
/// Optional <see cref="BlobRequestConditions"/> to add conditions on
/// downloading this blob.
/// </summary>
public BlobRequestConditions Conditions { get; set; }
/// <summary>
/// Optional <see cref="IProgress{Long}"/> to provide
/// progress updates about data transfers.
/// </summary>
public IProgress<long> ProgressHandler { get; set; }
/// <summary>
/// Optional override settings for this client's <see cref="BlobClientOptions.TransferValidation"/> settings.
/// Set <see cref="DownloadTransferValidationOptions.AutoValidateChecksum"/> to false if you
/// would like to skip SDK checksum validation and validate the checksum found
/// in the <see cref="Response"/> object yourself.
/// Range must be provided explicitly, stating a range withing Azure
/// Storage size limits for requesting a transactional hash. See the
/// <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob">
/// REST documentation</a> for range limitation details.
/// </summary>
public DownloadTransferValidationOptions TransferValidation { get; set; }
}
}