-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
DataLakeOpenReadOptions.cs
48 lines (42 loc) · 1.69 KB
/
DataLakeOpenReadOptions.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
45
46
47
48
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
namespace Azure.Storage.Files.DataLake.Models
{
/// <summary>
/// Optional parameters for <see cref="DataLakeFileClient.OpenReadAsync(DataLakeOpenReadOptions, System.Threading.CancellationToken)"/>
/// </summary>
public class DataLakeOpenReadOptions
{
/// <summary>
/// The position within the file to begin the stream.
/// Defaults to the beginning of the file.
/// </summary>
public long Position { get; set; }
/// <summary>
/// The buffer size to use when the stream downloads parts
/// of the file. Defaults to 4 MB.
/// </summary>
public int? BufferSize { get; set; }
/// <summary>
/// Optional <see cref="DataLakeRequestConditions"/> to add conditions on
/// the download of the file.
/// </summary>
public DataLakeRequestConditions Conditions { get; set; }
/// <summary>
/// Optional override settings for this client's <see cref="DataLakeClientOptions.TransferValidation"/> settings.
/// </summary>
public DownloadTransferValidationOptions TransferValidation { get; set; }
internal bool AllowModifications { get; }
/// <summary>
/// Constructor.
/// </summary>
/// <param name="allowModifications">
/// If false, a <see cref="RequestFailedException"/> will be thrown if the file is modified while
/// it is being read from.
/// </param>
public DataLakeOpenReadOptions(bool allowModifications)
{
AllowModifications = allowModifications;
}
}
}