STG 93 API View Comments (#43999)

Azure · May 13, 2024 · b716566 · b716566
1 parent 209d5cf
commit b716566
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 37 deletions.
diff --git a/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.net6.0.cs b/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.net6.0.cs
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
         public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
         public bool EnableTenantDiscovery { get { throw null; } set { } }
         public string EncryptionScope { get { throw null; } set { } }
-        public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
         public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
+        public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
         public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
         public bool TrimBlobNameSlashes { get { throw null; } set { } }
         public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

diff --git a/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.0.cs b/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.0.cs
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
         public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
         public bool EnableTenantDiscovery { get { throw null; } set { } }
         public string EncryptionScope { get { throw null; } set { } }
-        public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
         public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
+        public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
         public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
         public bool TrimBlobNameSlashes { get { throw null; } set { } }
         public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

diff --git a/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.1.cs b/sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.1.cs
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
         public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
         public bool EnableTenantDiscovery { get { throw null; } set { } }
         public string EncryptionScope { get { throw null; } set { } }
-        public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
         public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
+        public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
         public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
         public bool TrimBlobNameSlashes { get { throw null; } set { } }
         public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs
@@ -191,7 +191,7 @@ public enum ServiceVersion
         /// <summary>
         /// Behavior options for setting HTTP header <c>Expect: 100-continue</c> on requests.
         /// </summary>
-        public ExpectContinueOptions ExpectContinueBehavior { get; set; }
+        public Request100ContinueOptions Request100ContinueOptions { get; set; }
 
         #region Advanced Options
         internal ClientSideEncryptionOptions _clientSideEncryptionOptions;
@@ -344,7 +344,7 @@ private void AddHeadersAndQueryParameters()
         /// <returns>An HttpPipeline to use for Storage requests.</returns>
         internal HttpPipeline Build(HttpPipelinePolicy authentication = null)
         {
-            return this.Build(authentication, GeoRedundantSecondaryUri, ExpectContinueBehavior);
+            return this.Build(authentication, GeoRedundantSecondaryUri, Request100ContinueOptions);
         }
 
         /// <summary>
@@ -354,7 +354,7 @@ internal HttpPipeline Build(HttpPipelinePolicy authentication = null)
         /// <returns>An HttpPipeline to use for Storage requests.</returns>
         internal HttpPipeline Build(object credentials)
         {
-            return this.Build(credentials, GeoRedundantSecondaryUri, ExpectContinueBehavior);
+            return this.Build(credentials, GeoRedundantSecondaryUri, Request100ContinueOptions);
         }
 
         /// <inheritdoc />

diff --git a/sdk/storage/Azure.Storage.Blobs/tests/BlobClientTests.cs b/sdk/storage/Azure.Storage.Blobs/tests/BlobClientTests.cs
@@ -1337,7 +1337,7 @@ public async Task UploadAsync_ExpectContinue()
             });
 
             BlobClientOptions options = GetOptions();
-            options.ExpectContinueBehavior = new() { Mode = ExpectContinueMode.On };
+            options.Request100ContinueOptions = new() { Mode = Request100ContinueMode.Always };
             options.AddPolicy(assertPolicy, Core.HttpPipelinePosition.BeforeTransport);
             await using DisposingContainer test = await GetTestContainerAsync(
                 BlobsClientBuilder.GetServiceClient_SharedKey(options));

diff --git a/sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.net6.0.cs b/sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.net6.0.cs
@@ -20,18 +20,18 @@ public DownloadTransferValidationOptions() { }
         public bool AutoValidateChecksum { get { throw null; } set { } }
         public Azure.Storage.StorageChecksumAlgorithm ChecksumAlgorithm { get { throw null; } set { } }
     }
-    public enum ExpectContinueMode
+    public enum Request100ContinueMode
     {
-        ApplyOnThrottle = 0,
-        On = 1,
-        Off = 2,
+        Auto = 0,
+        Always = 1,
+        Never = 2,
     }
-    public partial class ExpectContinueOptions
+    public partial class Request100ContinueOptions
     {
-        public ExpectContinueOptions() { }
+        public Request100ContinueOptions() { }
+        public System.TimeSpan AutoInterval { get { throw null; } set { } }
         public long? ContentLengthThreshold { get { throw null; } set { } }
-        public Azure.Storage.ExpectContinueMode Mode { get { throw null; } set { } }
-        public System.TimeSpan ThrottleInterval { get { throw null; } set { } }
+        public Azure.Storage.Request100ContinueMode Mode { get { throw null; } set { } }
     }
     public enum StorageChecksumAlgorithm
     {

diff --git a/sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.netstandard2.0.cs b/sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.netstandard2.0.cs
@@ -20,18 +20,18 @@ public DownloadTransferValidationOptions() { }
         public bool AutoValidateChecksum { get { throw null; } set { } }
         public Azure.Storage.StorageChecksumAlgorithm ChecksumAlgorithm { get { throw null; } set { } }
     }
-    public enum ExpectContinueMode
+    public enum Request100ContinueMode
     {
-        ApplyOnThrottle = 0,
-        On = 1,
-        Off = 2,
+        Auto = 0,
+        Always = 1,
+        Never = 2,
     }
-    public partial class ExpectContinueOptions
+    public partial class Request100ContinueOptions
     {
-        public ExpectContinueOptions() { }
+        public Request100ContinueOptions() { }
+        public System.TimeSpan AutoInterval { get { throw null; } set { } }
         public long? ContentLengthThreshold { get { throw null; } set { } }
-        public Azure.Storage.ExpectContinueMode Mode { get { throw null; } set { } }
-        public System.TimeSpan ThrottleInterval { get { throw null; } set { } }
+        public Azure.Storage.Request100ContinueMode Mode { get { throw null; } set { } }
     }
     public enum StorageChecksumAlgorithm
     {

diff --git a/....Storage.Common/src/ExpectContinueMode.cs → ...rage.Common/src/Request100ContinueMode.cs b/....Storage.Common/src/ExpectContinueMode.cs → ...rage.Common/src/Request100ContinueMode.cs
@@ -6,7 +6,7 @@ namespace Azure.Storage
     /// <summary>
     /// Mode for applying expect-continue to a PUT request.
     /// </summary>
-    public enum ExpectContinueMode
+    public enum Request100ContinueMode
     {
         /// <summary>
         /// If no options are provided, this is the default behavior.
@@ -19,17 +19,17 @@ public enum ExpectContinueMode
         /// Response codes that trigger this behavior are 429, 500, and 503.
         /// </para>
         /// </summary>
-        ApplyOnThrottle = 0,
+        Auto = 0,
 
         /// <summary>
         /// Expect-continue will be applied regardless of recent error status. There may be
         /// some additionally defined thresholds for applying the header.
         /// </summary>
-        On = 1,
+        Always = 1,
 
         /// <summary>
         /// Expect-Continue will never be applied.
         /// </summary>
-        Off = 2,
+        Never = 2,
     }
 }
diff --git a/...orage.Common/src/ExpectContinueOptions.cs → ...e.Common/src/Request100ContinueOptions.cs b/...orage.Common/src/ExpectContinueOptions.cs → ...e.Common/src/Request100ContinueOptions.cs
@@ -8,22 +8,22 @@ namespace Azure.Storage
     /// <summary>
     /// Options for applying HTTP header <c>Expect: 100-continue</c> to PUT operations.
     /// </summary>
-    public class ExpectContinueOptions
+    public class Request100ContinueOptions
     {
         /// <summary>
         /// Mode for these options.
         /// </summary>
-        public ExpectContinueMode Mode { get; set; }
+        public Request100ContinueMode Mode { get; set; }
 
         /// <summary>
         /// The minimum value of HTTP request Content-Length for applying expect-continue.
         /// </summary>
         public long? ContentLengthThreshold { get; set; }
 
         /// <summary>
-        /// In mode <see cref="ExpectContinueMode.ApplyOnThrottle"/>, the time interval to apply the header
+        /// In mode <see cref="Request100ContinueMode.Auto"/>, the time interval to apply the header
         /// after recieving a triggering error. The default time is one minute.
         /// </summary>
-        public TimeSpan ThrottleInterval { get; set; } = TimeSpan.FromMinutes(1);
+        public TimeSpan AutoInterval { get; set; } = TimeSpan.FromMinutes(1);
     }
 }
diff --git a/sdk/storage/Azure.Storage.Common/src/Shared/StorageClientOptions.cs b/sdk/storage/Azure.Storage.Common/src/Shared/StorageClientOptions.cs
@@ -109,7 +109,7 @@ public static HttpPipeline Build(
             this ClientOptions options,
             HttpPipelinePolicy authentication = null,
             Uri geoRedundantSecondaryStorageUri = null,
-            ExpectContinueOptions expectContinue = null)
+            Request100ContinueOptions expectContinue = null)
         {
             StorageResponseClassifier classifier = new();
             var pipelineOptions = new HttpPipelineOptions(options)
@@ -131,20 +131,20 @@ public static HttpPipeline Build(
             {
                 switch (expectContinue.Mode)
                 {
-                    case ExpectContinueMode.ApplyOnThrottle:
+                    case Request100ContinueMode.Auto:
                         pipelineOptions.PerCallPolicies.Add(new ExpectContinueOnThrottlePolicy()
                         {
-                            ThrottleInterval = expectContinue.ThrottleInterval,
+                            ThrottleInterval = expectContinue.AutoInterval,
                             ContentLengthThreshold = expectContinue.ContentLengthThreshold ?? 0,
                         });
                         break;
-                    case ExpectContinueMode.On:
+                    case Request100ContinueMode.Always:
                         pipelineOptions.PerCallPolicies.Add(new ExpectContinuePolicy()
                         {
                             ContentLengthThreshold = expectContinue.ContentLengthThreshold ?? 0,
                         });
                         break;
-                    case ExpectContinueMode.Off:
+                    case Request100ContinueMode.Never:
                         break;
                 }
             }
@@ -172,7 +172,7 @@ public static HttpPipeline Build(
             this ClientOptions options,
             object credentials,
             Uri geoRedundantSecondaryStorageUri = null,
-            ExpectContinueOptions expectContinue = null) =>
+            Request100ContinueOptions expectContinue = null) =>
             Build(options, GetAuthenticationPolicy(credentials), geoRedundantSecondaryStorageUri, expectContinue);
     }
 }