@@ -94,10 +94,10 @@ class _Constants:
9494
9595 class Kwargs :
9696 """Keyword arguments used in the azure-cosmos package
97-
97+
9898 These constants should be used instead of hardcoded strings for request options
9999 to improve maintainability, reduce errors, and provide better IDE support.
100-
100+
101101 Best practices:
102102 - Always use these constants instead of hardcoded strings
103103 - Follow the naming convention: UPPER_SNAKE_CASE for constant names
@@ -108,124 +108,124 @@ class Kwargs:
108108 # Request option keys used in build_options and GetHeaders functions
109109 ACCESS_CONDITION : Literal ["accessCondition" ] = "accessCondition"
110110 """Access condition option for conditional operations (IfMatch, IfNoneMatch)."""
111-
111+
112112 AUTO_UPGRADE_POLICY : Literal ["autoUpgradePolicy" ] = "autoUpgradePolicy"
113113 """Auto-upgrade policy for autoscale settings."""
114-
114+
115115 CONSISTENCY_LEVEL : Literal ["consistencyLevel" ] = "consistencyLevel"
116116 """Consistency level override for the request."""
117-
117+
118118 CONTAINER_RID : Literal ["containerRID" ] = "containerRID"
119119 """Container resource ID for request routing."""
120-
120+
121121 CONTENT_TYPE : Literal ["contentType" ] = "contentType"
122122 """Content type for the request."""
123-
123+
124124 CONTINUATION : Literal ["continuation" ] = "continuation"
125125 """Continuation token for paginated queries."""
126-
126+
127127 CORRELATED_ACTIVITY_ID : Literal ["correlatedActivityId" ] = "correlatedActivityId"
128128 """Correlated activity ID for tracing and diagnostics."""
129-
129+
130130 DISABLE_RU_PER_MINUTE_USAGE : Literal [
131131 "disableRUPerMinuteUsage"
132132 ] = "disableRUPerMinuteUsage"
133133 """Whether to disable RU per minute usage."""
134-
134+
135135 ENABLE_CROSS_PARTITION_QUERY : Literal [
136136 "enableCrossPartitionQuery"
137137 ] = "enableCrossPartitionQuery"
138138 """Whether to enable cross-partition queries."""
139-
139+
140140 ENABLE_SCAN_IN_QUERY : Literal ["enableScanInQuery" ] = "enableScanInQuery"
141141 """Whether to enable scan in query operations."""
142-
142+
143143 ENABLE_SCRIPT_LOGGING : Literal ["enableScriptLogging" ] = "enableScriptLogging"
144144 """Whether to enable script logging for stored procedures."""
145-
145+
146146 EXCLUDED_LOCATIONS : Literal ["excludedLocations" ] = "excludedLocations"
147147 """List of locations to exclude for this request."""
148-
148+
149149 INDEXING_DIRECTIVE : Literal ["indexingDirective" ] = "indexingDirective"
150150 """Indexing directive for the operation."""
151-
151+
152152 INITIAL_HEADERS : Literal ["initialHeaders" ] = "initialHeaders"
153153 """Initial headers to include in the request."""
154-
154+
155155 IS_QUERY_PLAN_REQUEST : Literal ["isQueryPlanRequest" ] = "isQueryPlanRequest"
156156 """Whether this is a query plan request."""
157-
157+
158158 MAX_INTEGRATED_CACHE_STALENESS : Literal [
159159 "maxIntegratedCacheStaleness"
160160 ] = "maxIntegratedCacheStaleness"
161161 """Maximum integrated cache staleness in milliseconds."""
162-
162+
163163 MAX_ITEM_COUNT : Literal ["maxItemCount" ] = "maxItemCount"
164164 """Maximum number of items to return in the response."""
165-
165+
166166 OFFER_ENABLE_RU_PER_MINUTE_THROUGHPUT : Literal [
167167 "offerEnableRUPerMinuteThroughput"
168168 ] = "offerEnableRUPerMinuteThroughput"
169169 """Whether to enable RU per minute throughput for the offer."""
170-
170+
171171 OFFER_THROUGHPUT : Literal ["offerThroughput" ] = "offerThroughput"
172172 """Throughput value for the offer."""
173-
173+
174174 OFFER_TYPE : Literal ["offerType" ] = "offerType"
175175 """Type of the offer (S1, S2, S3, etc.)."""
176-
176+
177177 PARTITION_KEY : Literal ["partitionKey" ] = "partitionKey"
178178 """Partition key value for the request."""
179-
179+
180180 POPULATE_INDEX_METRICS : Literal ["populateIndexMetrics" ] = "populateIndexMetrics"
181181 """Whether to populate index metrics in the response."""
182-
182+
183183 POPULATE_PARTITION_KEY_RANGE_STATISTICS : Literal [
184184 "populatePartitionKeyRangeStatistics"
185185 ] = "populatePartitionKeyRangeStatistics"
186186 """Whether to populate partition key range statistics."""
187-
187+
188188 POPULATE_QUERY_METRICS : Literal ["populateQueryMetrics" ] = "populateQueryMetrics"
189189 """Whether to populate query metrics in the response."""
190-
190+
191191 POPULATE_QUOTA_INFO : Literal ["populateQuotaInfo" ] = "populateQuotaInfo"
192192 """Whether to populate quota information in the response."""
193-
193+
194194 POST_TRIGGER_INCLUDE : Literal ["postTriggerInclude" ] = "postTriggerInclude"
195195 """Post-trigger scripts to include in the operation."""
196-
196+
197197 PRE_TRIGGER_INCLUDE : Literal ["preTriggerInclude" ] = "preTriggerInclude"
198198 """Pre-trigger scripts to include in the operation."""
199-
199+
200200 PRIORITY_LEVEL : Literal ["priorityLevel" ] = "priorityLevel"
201201 """Priority level for the request (High, Low)."""
202-
202+
203203 QUERY_VERSION : Literal ["queryVersion" ] = "queryVersion"
204204 """Query version for the request."""
205-
205+
206206 RESOURCE_TOKEN_EXPIRY_SECONDS : Literal [
207207 "resourceTokenExpirySeconds"
208208 ] = "resourceTokenExpirySeconds"
209209 """Resource token expiry time in seconds."""
210-
210+
211211 RESPONSE_CONTINUATION_TOKEN_LIMIT_IN_KB : Literal [
212212 "responseContinuationTokenLimitInKb"
213213 ] = "responseContinuationTokenLimitInKb"
214214 """Continuation token size limit in KB."""
215-
215+
216216 RESPONSE_PAYLOAD_ON_WRITE_DISABLED : Literal [
217217 "responsePayloadOnWriteDisabled"
218218 ] = "responsePayloadOnWriteDisabled"
219219 """Whether to disable response payload on write operations."""
220220
221221 RETRY_WRITE : Literal ["retry_write" ] = "retry_write"
222222 """Whether to retry write operations if they fail. Used either at client level or request level."""
223-
223+
224224 SESSION_TOKEN : Literal ["sessionToken" ] = "sessionToken"
225225 """Session token for session consistency."""
226-
226+
227227 SUPPORTED_QUERY_FEATURES : Literal ["supportedQueryFeatures" ] = "supportedQueryFeatures"
228228 """Supported query features for the request."""
229-
229+
230230 THROUGHPUT_BUCKET : Literal ["throughputBucket" ] = "throughputBucket"
231231 """Throughput bucket for the request."""
0 commit comments