Skip to content

Commit b716566

Browse files
authored
STG 93 API View Comments (Azure#43999)
1 parent 209d5cf commit b716566

10 files changed

+37
-37
lines changed

sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.net6.0.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
5656
public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
5757
public bool EnableTenantDiscovery { get { throw null; } set { } }
5858
public string EncryptionScope { get { throw null; } set { } }
59-
public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
6059
public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
60+
public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
6161
public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
6262
public bool TrimBlobNameSlashes { get { throw null; } set { } }
6363
public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.0.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
5656
public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
5757
public bool EnableTenantDiscovery { get { throw null; } set { } }
5858
public string EncryptionScope { get { throw null; } set { } }
59-
public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
6059
public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
60+
public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
6161
public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
6262
public bool TrimBlobNameSlashes { get { throw null; } set { } }
6363
public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

sdk/storage/Azure.Storage.Blobs/api/Azure.Storage.Blobs.netstandard2.1.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ public BlobClientOptions(Azure.Storage.Blobs.BlobClientOptions.ServiceVersion ve
5656
public Azure.Storage.Blobs.Models.CustomerProvidedKey? CustomerProvidedKey { get { throw null; } set { } }
5757
public bool EnableTenantDiscovery { get { throw null; } set { } }
5858
public string EncryptionScope { get { throw null; } set { } }
59-
public Azure.Storage.ExpectContinueOptions ExpectContinueBehavior { get { throw null; } set { } }
6059
public System.Uri GeoRedundantSecondaryUri { get { throw null; } set { } }
60+
public Azure.Storage.Request100ContinueOptions Request100ContinueOptions { get { throw null; } set { } }
6161
public Azure.Storage.TransferValidationOptions TransferValidation { get { throw null; } }
6262
public bool TrimBlobNameSlashes { get { throw null; } set { } }
6363
public Azure.Storage.Blobs.BlobClientOptions.ServiceVersion Version { get { throw null; } }

sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ public enum ServiceVersion
191191
/// <summary>
192192
/// Behavior options for setting HTTP header <c>Expect: 100-continue</c> on requests.
193193
/// </summary>
194-
public ExpectContinueOptions ExpectContinueBehavior { get; set; }
194+
public Request100ContinueOptions Request100ContinueOptions { get; set; }
195195

196196
#region Advanced Options
197197
internal ClientSideEncryptionOptions _clientSideEncryptionOptions;
@@ -344,7 +344,7 @@ private void AddHeadersAndQueryParameters()
344344
/// <returns>An HttpPipeline to use for Storage requests.</returns>
345345
internal HttpPipeline Build(HttpPipelinePolicy authentication = null)
346346
{
347-
return this.Build(authentication, GeoRedundantSecondaryUri, ExpectContinueBehavior);
347+
return this.Build(authentication, GeoRedundantSecondaryUri, Request100ContinueOptions);
348348
}
349349

350350
/// <summary>
@@ -354,7 +354,7 @@ internal HttpPipeline Build(HttpPipelinePolicy authentication = null)
354354
/// <returns>An HttpPipeline to use for Storage requests.</returns>
355355
internal HttpPipeline Build(object credentials)
356356
{
357-
return this.Build(credentials, GeoRedundantSecondaryUri, ExpectContinueBehavior);
357+
return this.Build(credentials, GeoRedundantSecondaryUri, Request100ContinueOptions);
358358
}
359359

360360
/// <inheritdoc />

sdk/storage/Azure.Storage.Blobs/tests/BlobClientTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1337,7 +1337,7 @@ public async Task UploadAsync_ExpectContinue()
13371337
});
13381338

13391339
BlobClientOptions options = GetOptions();
1340-
options.ExpectContinueBehavior = new() { Mode = ExpectContinueMode.On };
1340+
options.Request100ContinueOptions = new() { Mode = Request100ContinueMode.Always };
13411341
options.AddPolicy(assertPolicy, Core.HttpPipelinePosition.BeforeTransport);
13421342
await using DisposingContainer test = await GetTestContainerAsync(
13431343
BlobsClientBuilder.GetServiceClient_SharedKey(options));

sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.net6.0.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ public DownloadTransferValidationOptions() { }
2020
public bool AutoValidateChecksum { get { throw null; } set { } }
2121
public Azure.Storage.StorageChecksumAlgorithm ChecksumAlgorithm { get { throw null; } set { } }
2222
}
23-
public enum ExpectContinueMode
23+
public enum Request100ContinueMode
2424
{
25-
ApplyOnThrottle = 0,
26-
On = 1,
27-
Off = 2,
25+
Auto = 0,
26+
Always = 1,
27+
Never = 2,
2828
}
29-
public partial class ExpectContinueOptions
29+
public partial class Request100ContinueOptions
3030
{
31-
public ExpectContinueOptions() { }
31+
public Request100ContinueOptions() { }
32+
public System.TimeSpan AutoInterval { get { throw null; } set { } }
3233
public long? ContentLengthThreshold { get { throw null; } set { } }
33-
public Azure.Storage.ExpectContinueMode Mode { get { throw null; } set { } }
34-
public System.TimeSpan ThrottleInterval { get { throw null; } set { } }
34+
public Azure.Storage.Request100ContinueMode Mode { get { throw null; } set { } }
3535
}
3636
public enum StorageChecksumAlgorithm
3737
{

sdk/storage/Azure.Storage.Common/api/Azure.Storage.Common.netstandard2.0.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ public DownloadTransferValidationOptions() { }
2020
public bool AutoValidateChecksum { get { throw null; } set { } }
2121
public Azure.Storage.StorageChecksumAlgorithm ChecksumAlgorithm { get { throw null; } set { } }
2222
}
23-
public enum ExpectContinueMode
23+
public enum Request100ContinueMode
2424
{
25-
ApplyOnThrottle = 0,
26-
On = 1,
27-
Off = 2,
25+
Auto = 0,
26+
Always = 1,
27+
Never = 2,
2828
}
29-
public partial class ExpectContinueOptions
29+
public partial class Request100ContinueOptions
3030
{
31-
public ExpectContinueOptions() { }
31+
public Request100ContinueOptions() { }
32+
public System.TimeSpan AutoInterval { get { throw null; } set { } }
3233
public long? ContentLengthThreshold { get { throw null; } set { } }
33-
public Azure.Storage.ExpectContinueMode Mode { get { throw null; } set { } }
34-
public System.TimeSpan ThrottleInterval { get { throw null; } set { } }
34+
public Azure.Storage.Request100ContinueMode Mode { get { throw null; } set { } }
3535
}
3636
public enum StorageChecksumAlgorithm
3737
{

sdk/storage/Azure.Storage.Common/src/ExpectContinueMode.cs renamed to sdk/storage/Azure.Storage.Common/src/Request100ContinueMode.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace Azure.Storage
66
/// <summary>
77
/// Mode for applying expect-continue to a PUT request.
88
/// </summary>
9-
public enum ExpectContinueMode
9+
public enum Request100ContinueMode
1010
{
1111
/// <summary>
1212
/// If no options are provided, this is the default behavior.
@@ -19,17 +19,17 @@ public enum ExpectContinueMode
1919
/// Response codes that trigger this behavior are 429, 500, and 503.
2020
/// </para>
2121
/// </summary>
22-
ApplyOnThrottle = 0,
22+
Auto = 0,
2323

2424
/// <summary>
2525
/// Expect-continue will be applied regardless of recent error status. There may be
2626
/// some additionally defined thresholds for applying the header.
2727
/// </summary>
28-
On = 1,
28+
Always = 1,
2929

3030
/// <summary>
3131
/// Expect-Continue will never be applied.
3232
/// </summary>
33-
Off = 2,
33+
Never = 2,
3434
}
3535
}

sdk/storage/Azure.Storage.Common/src/ExpectContinueOptions.cs renamed to sdk/storage/Azure.Storage.Common/src/Request100ContinueOptions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,22 @@ namespace Azure.Storage
88
/// <summary>
99
/// Options for applying HTTP header <c>Expect: 100-continue</c> to PUT operations.
1010
/// </summary>
11-
public class ExpectContinueOptions
11+
public class Request100ContinueOptions
1212
{
1313
/// <summary>
1414
/// Mode for these options.
1515
/// </summary>
16-
public ExpectContinueMode Mode { get; set; }
16+
public Request100ContinueMode Mode { get; set; }
1717

1818
/// <summary>
1919
/// The minimum value of HTTP request Content-Length for applying expect-continue.
2020
/// </summary>
2121
public long? ContentLengthThreshold { get; set; }
2222

2323
/// <summary>
24-
/// In mode <see cref="ExpectContinueMode.ApplyOnThrottle"/>, the time interval to apply the header
24+
/// In mode <see cref="Request100ContinueMode.Auto"/>, the time interval to apply the header
2525
/// after recieving a triggering error. The default time is one minute.
2626
/// </summary>
27-
public TimeSpan ThrottleInterval { get; set; } = TimeSpan.FromMinutes(1);
27+
public TimeSpan AutoInterval { get; set; } = TimeSpan.FromMinutes(1);
2828
}
2929
}

sdk/storage/Azure.Storage.Common/src/Shared/StorageClientOptions.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public static HttpPipeline Build(
109109
this ClientOptions options,
110110
HttpPipelinePolicy authentication = null,
111111
Uri geoRedundantSecondaryStorageUri = null,
112-
ExpectContinueOptions expectContinue = null)
112+
Request100ContinueOptions expectContinue = null)
113113
{
114114
StorageResponseClassifier classifier = new();
115115
var pipelineOptions = new HttpPipelineOptions(options)
@@ -131,20 +131,20 @@ public static HttpPipeline Build(
131131
{
132132
switch (expectContinue.Mode)
133133
{
134-
case ExpectContinueMode.ApplyOnThrottle:
134+
case Request100ContinueMode.Auto:
135135
pipelineOptions.PerCallPolicies.Add(new ExpectContinueOnThrottlePolicy()
136136
{
137-
ThrottleInterval = expectContinue.ThrottleInterval,
137+
ThrottleInterval = expectContinue.AutoInterval,
138138
ContentLengthThreshold = expectContinue.ContentLengthThreshold ?? 0,
139139
});
140140
break;
141-
case ExpectContinueMode.On:
141+
case Request100ContinueMode.Always:
142142
pipelineOptions.PerCallPolicies.Add(new ExpectContinuePolicy()
143143
{
144144
ContentLengthThreshold = expectContinue.ContentLengthThreshold ?? 0,
145145
});
146146
break;
147-
case ExpectContinueMode.Off:
147+
case Request100ContinueMode.Never:
148148
break;
149149
}
150150
}
@@ -172,7 +172,7 @@ public static HttpPipeline Build(
172172
this ClientOptions options,
173173
object credentials,
174174
Uri geoRedundantSecondaryStorageUri = null,
175-
ExpectContinueOptions expectContinue = null) =>
175+
Request100ContinueOptions expectContinue = null) =>
176176
Build(options, GetAuthenticationPolicy(credentials), geoRedundantSecondaryStorageUri, expectContinue);
177177
}
178178
}

0 commit comments

Comments
 (0)