Skip to content
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

ThroughputBucketing: Fixes ThroughputBucket to always be internal #4960

Merged
merged 17 commits into from
Jan 13, 2025
Merged

ThroughputBucketing: Fixes ThroughputBucket to always be internal #4960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
bbea67a
Added Throughput Bucket to RequestOptions and ClientOptions
Achint-Agrawal Dec 26, 2024
83046d9
Reverted solution file
Achint-Agrawal Dec 27, 2024
961cac4
Addressed comments
Achint-Agrawal Jan 2, 2025
3c12a54
Merge branch 'master' into users/acagrawal/throughputBucketing/addReq…
Achint-Agrawal Jan 2, 2025
f162cd7
Forcing an empty commit.
Achint-Agrawal Jan 2, 2025
8091e2a
Used invariant culture for serialization
Achint-Agrawal Jan 2, 2025
7f0b260
Made changes to only expose ThroughputBucket in preview SDK
Achint-Agrawal Jan 3, 2025
a11049c
Updated contracts
Achint-Agrawal Jan 5, 2025
611e5db
Merge branch 'master' into users/acagrawal/throughputBucketing/addReq…
Achint-Agrawal Jan 5, 2025
0dfc9c4
Made WithThroughputBucket argument non nullable
Achint-Agrawal Jan 6, 2025
8e9a672
Updated contracts
Achint-Agrawal Jan 6, 2025
999047e
Merge branch 'master' into users/acagrawal/throughputBucketing/addReq…
Achint-Agrawal Jan 7, 2025
10a0b11
Merge branch 'master' of https://github.com/Azure/azure-cosmos-dotnet…
Achint-Agrawal Jan 8, 2025
b74b066
Corrected verbiage
Achint-Agrawal Jan 8, 2025
dbfac24
Made Throughput Bucket internal
Achint-Agrawal Jan 10, 2025
de1d94a
resolved merge conflict
Achint-Agrawal Jan 10, 2025
1099846
Updated Contracts
Achint-Agrawal Jan 10, 2025
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
7 changes: 1 addition & 6 deletions Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,12 +948,7 @@ public IFaultInjector FaultInjector
/// If <see cref="AllowBulkExecution"/> is set to true in CosmosClientOptions, throughput bucket can only be set at client level.
/// </remarks>
/// <seealso href="https://aka.ms/cosmsodb-bucketing"/>
#if PREVIEW
public
#else
internal
#endif
int? ThroughputBucket { get; set; }
internal int? ThroughputBucket { get; set; }

internal IChaosInterceptorFactory ChaosInterceptorFactory { get; set; }

Expand Down
7 changes: 1 addition & 6 deletions Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,12 +813,7 @@ public CosmosClientBuilder WithClientTelemetryOptions(CosmosClientTelemetryOptio
/// <param name="throughputBucket">The desired throughput bucket for the client.</param>
/// <returns>The current <see cref="CosmosClientBuilder"/>.</returns>
/// <seealso href="https://aka.ms/cosmsodb-bucketing"/>
#if PREVIEW
public
#else
internal
#endif
CosmosClientBuilder WithThroughputBucket(int throughputBucket)
internal CosmosClientBuilder WithThroughputBucket(int throughputBucket)
{
this.clientOptions.ThroughputBucket = throughputBucket;
return this;
Expand Down
13 changes: 4 additions & 9 deletions Microsoft.Azure.Cosmos/src/RequestOptions/RequestOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,21 +115,16 @@ public class RequestOptions
internal virtual ConsistencyLevel? BaseConsistencyLevel { get; set; }

internal bool DisablePointOperationDiagnostics { get; set; }
/// <summary>

/// <summary>
/// Gets or sets the throughput bucket for a request.
/// </summary>
/// <remarks>
/// If <see cref="CosmosClientOptions.AllowBulkExecution"/> is set to true on CosmosClient,
/// <see cref="RequestOptions.ThroughputBucket"/> cannot be set in RequestOptions.
/// </remarks>
/// <seealso href="https://aka.ms/cosmsodb-bucketing"/>
#if PREVIEW
public
#else
internal
#endif
int? ThroughputBucket { get; set; }
internal int? ThroughputBucket { get; set; }

/// <summary>
/// Fill the CosmosRequestMessage headers with the set properties
Expand Down Expand Up @@ -159,7 +154,7 @@ internal virtual void PopulateRequestOptions(RequestMessage request)
{
request.Headers.Add(HttpConstants.HttpHeaders.PriorityLevel, this.PriorityLevel.ToString());
}

if (this.ThroughputBucket.HasValue)
{
request.Headers.Add(HttpConstants.HttpHeaders.ThroughputBucket, this.ThroughputBucket?.ToString(CultureInfo.InvariantCulture));
Expand Down
43 changes: 0 additions & 43 deletions Microsoft.Azure.Cosmos/tests/Microsoft.Azure.Cosmos.Tests/Contracts/DotNetPreviewSDKAPI.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,31 +403,12 @@
],
"MethodInfo": "Microsoft.Azure.Cosmos.AvailabilityStrategy get_AvailabilityStrategy();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.Nullable`1[System.Int32] get_ThroughputBucket()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "System.Nullable`1[System.Int32] get_ThroughputBucket();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.Nullable`1[System.Int32] ThroughputBucket": {
"Type": "Property",
"Attributes": [],
"MethodInfo": "System.Nullable`1[System.Int32] ThroughputBucket;CanRead:True;CanWrite:True;System.Nullable`1[System.Int32] get_ThroughputBucket();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_ThroughputBucket(System.Nullable`1[System.Int32]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_AvailabilityStrategy(Microsoft.Azure.Cosmos.AvailabilityStrategy)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "Void set_AvailabilityStrategy(Microsoft.Azure.Cosmos.AvailabilityStrategy);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_ThroughputBucket(System.Nullable`1[System.Int32])[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "Void set_ThroughputBucket(System.Nullable`1[System.Int32]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
}
},
"NestedTypes": {}
Expand Down Expand Up @@ -493,11 +474,6 @@
"Type": "Method",
"Attributes": [],
"MethodInfo": "Microsoft.Azure.Cosmos.Fluent.CosmosClientBuilder WithAvailabilityStrategy(Microsoft.Azure.Cosmos.AvailabilityStrategy);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Microsoft.Azure.Cosmos.Fluent.CosmosClientBuilder WithThroughputBucket(Int32)": {
"Type": "Method",
"Attributes": [],
"MethodInfo": "Microsoft.Azure.Cosmos.Fluent.CosmosClientBuilder WithThroughputBucket(Int32);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
}
},
"NestedTypes": {}
Expand Down Expand Up @@ -765,31 +741,12 @@
],
"MethodInfo": "Microsoft.Azure.Cosmos.AvailabilityStrategy get_AvailabilityStrategy();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.Nullable`1[System.Int32] get_ThroughputBucket()[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "System.Nullable`1[System.Int32] get_ThroughputBucket();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"System.Nullable`1[System.Int32] ThroughputBucket": {
"Type": "Property",
"Attributes": [],
"MethodInfo": "System.Nullable`1[System.Int32] ThroughputBucket;CanRead:True;CanWrite:True;System.Nullable`1[System.Int32] get_ThroughputBucket();IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;Void set_ThroughputBucket(System.Nullable`1[System.Int32]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_AvailabilityStrategy(Microsoft.Azure.Cosmos.AvailabilityStrategy)[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "Void set_AvailabilityStrategy(Microsoft.Azure.Cosmos.AvailabilityStrategy);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
},
"Void set_ThroughputBucket(System.Nullable`1[System.Int32])[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]": {
"Type": "Method",
"Attributes": [
"CompilerGeneratedAttribute"
],
"MethodInfo": "Void set_ThroughputBucket(System.Nullable`1[System.Int32]);IsAbstract:False;IsStatic:False;IsVirtual:False;IsGenericMethod:False;IsConstructor:False;IsFinal:False;"
}
},
"NestedTypes": {}
Expand Down
Loading