Skip to content

Doc updates #4229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GarrettBeatty merged 1 commit into from
Dec 12, 2025
+169 −4
Merged

Doc updates #4229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/src/Services/S3/Custom/Transfer/TransferUtilityDownloadDirectoryRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ internal bool IsSetUnmodifiedSinceDate()
/// Specifies if multiple files will be downloaded concurrently.
/// The number of concurrent web requests used is controlled
/// by the TransferUtilityConfig.ConcurrencyLevel property.
/// The default value is <c>false</c>.
/// </summary>
#if BCL || NETSTANDARD
public
Expand Down
86 changes: 84 additions & 2 deletions sdk/src/Services/S3/Custom/Transfer/_async/ITransferUtility.async.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,26 @@ public partial interface ITransferUtility : IDisposable
/// <item><description>Downloaded parts are written directly to the file as they arrive</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand Down Expand Up @@ -393,6 +413,26 @@ public partial interface ITransferUtility : IDisposable
/// <item><description>Downloaded parts are written directly to the file as they arrive</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand All @@ -418,7 +458,8 @@ public partial interface ITransferUtility : IDisposable
/// BucketName = "my-bucket",
/// Key = "my-key",
/// FilePath = "local-file.txt",
/// PartSize = 16 * 1024 * 1024 // Use 16MB parts instead of default 8MB
/// PartSize = 16 * 1024 * 1024, // Use 16MB parts instead of default 8MB
/// MultipartDownloadType = MultipartDownloadType.RANGE // Enable RANGE mode to use custom PartSize
/// };
/// var response = await transferUtility.DownloadWithResponseAsync(request);
/// </code>
Expand Down Expand Up @@ -534,6 +575,26 @@ public partial interface ITransferUtility : IDisposable
/// <item><description>Downloaded parts are buffered in memory and served to your application as you read from the stream</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand Down Expand Up @@ -589,6 +650,26 @@ public partial interface ITransferUtility : IDisposable
/// <item><description>Downloaded parts are buffered in memory and served to your application as you read from the stream</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand All @@ -615,7 +696,8 @@ public partial interface ITransferUtility : IDisposable
/// {
/// BucketName = "my-bucket",
/// Key = "my-key",
/// PartSize = 16 * 1024 * 1024 // Use 16MB parts instead of default 8MB
/// PartSize = 16 * 1024 * 1024, // Use 16MB parts instead of default 8MB
/// MultipartDownloadType = MultipartDownloadType.RANGE // Enable RANGE mode to use custom PartSize
/// };
/// var response = await transferUtility.OpenStreamWithResponseAsync(request);
/// </code>
Expand Down
86 changes: 84 additions & 2 deletions sdk/src/Services/S3/Custom/Transfer/_bcl+netstandard/ITransferUtility.sync.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,26 @@ public partial interface ITransferUtility
/// <item><description>Downloaded parts are buffered in memory and served to your application as you read from the stream</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand Down Expand Up @@ -414,6 +434,26 @@ public partial interface ITransferUtility
/// <item><description>Downloaded parts are buffered in memory and served to your application as you read from the stream</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand All @@ -440,7 +480,8 @@ public partial interface ITransferUtility
/// {
/// BucketName = "my-bucket",
/// Key = "my-key",
/// PartSize = 16 * 1024 * 1024 // Use 16MB parts instead of default 8MB
/// PartSize = 16 * 1024 * 1024, // Use 16MB parts instead of default 8MB
/// MultipartDownloadType = MultipartDownloadType.RANGE // Enable RANGE mode to use custom PartSize
/// };
/// var response = transferUtility.OpenStreamWithResponse(request);
/// </code>
Expand Down Expand Up @@ -516,6 +557,26 @@ public partial interface ITransferUtility
/// <item><description>Downloaded parts are written directly to the file as they arrive</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand Down Expand Up @@ -563,6 +624,26 @@ public partial interface ITransferUtility
/// <item><description>Downloaded parts are written directly to the file as they arrive</description></item>
/// </list>
/// <para>
/// <b>Multipart Download Strategy:</b>
/// </para>
/// <para>
/// The <see cref="BaseDownloadRequest.MultipartDownloadType"/> property controls how parts are downloaded (default: <c>MultipartDownloadType.PART</c>):
/// </para>
/// <list type="bullet">
/// <item><description><b>PART (default)</b>: Uses the original part boundaries from when the object was uploaded with multipart upload.
/// This is more efficient as it aligns with S3's internal part structure, but <b>requires that the object was uploaded using multipart upload</b>.
/// The <see cref="BaseDownloadRequest.PartSize"/> property is ignored in this mode.</description></item>
/// <item><description><b>RANGE</b>: Uses range-based downloads with configurable part sizes via the <see cref="BaseDownloadRequest.PartSize"/> property.
/// This works with any object (whether uploaded as single-part or multipart) and provides more flexibility in controlling download part sizes.</description></item>
/// </list>
/// <para>
/// <b>When to use PART vs RANGE:</b>
/// </para>
/// <list type="bullet">
/// <item><description>Use <b>PART</b> mode (default) when you know the object was uploaded using multipart upload and want optimal performance.</description></item>
/// <item><description>Use <b>RANGE</b> mode when the object's upload method is unknown, when you need specific part sizes, or when downloading objects that were uploaded as a single part.</description></item>
/// </list>
/// <para>
/// <b>Configuration Options:</b>
/// </para>
/// <para>
Expand All @@ -588,7 +669,8 @@ public partial interface ITransferUtility
/// BucketName = "my-bucket",
/// Key = "my-key",
/// FilePath = "local-file.txt",
/// PartSize = 16 * 1024 * 1024 // Use 16MB parts instead of default 8MB
/// PartSize = 16 * 1024 * 1024, // Use 16MB parts instead of default 8MB
/// MultipartDownloadType = MultipartDownloadType.RANGE // Enable RANGE mode to use custom PartSize
/// };
/// var response = transferUtility.DownloadWithResponse(request);
/// </code>
Expand Down