Skip to content

Commit 885b6ca

Browse files
authored
Excluded Regions Documentation Update (Azure#44844)
* Update java docs for exclude regions behavior * React to comments
1 parent 301e9ed commit 885b6ca

File tree

7 files changed

+24
-10
lines changed

7 files changed

+24
-10
lines changed

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBatchRequestOptions.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,10 @@ CosmosBatchRequestOptions setHeader(String name, String value) {
148148
}
149149

150150
/**
151-
* List of regions to exclude for the request/retries. Example "East US" or "East US, West US"
152-
* These regions will be excluded from the preferred regions list
151+
* List of regions to be excluded for the request/retries. Example "East US" or "East US, West US"
152+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
153+
* the request will be sent to the primary region for the account. The primary region is the write region in a
154+
* single master account and the hub region in a multi-master account.
153155
*
154156
* @param excludeRegions list of regions
155157
* @return the {@link CosmosBatchRequestOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosBulkExecutionOptions.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,9 @@ public CosmosBulkExecutionOptions setThroughputControlGroupName(String throughpu
299299

300300
/**
301301
* List of regions to exclude for the request/retries. Example "East US" or "East US, West US"
302-
* These regions will be excluded from the preferred regions list
302+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
303+
* the request will be sent to the primary region for the account. The primary region is the write region in a
304+
* single master account and the hub region in a multi-master account.
303305
*
304306
* @param excludeRegions list of regions
305307
* @return the {@link CosmosBulkExecutionOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosChangeFeedRequestOptions.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,8 +510,10 @@ public CosmosChangeFeedRequestOptions setThroughputControlGroupName(String throu
510510
}
511511

512512
/**
513-
* List of regions to exclude for the request/retries. Example "East US" or "East US, West US"
514-
* These regions will be excluded from the preferred regions list
513+
* List of regions to be excluded for the request/retries. Example "East US" or "East US, West US"
514+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
515+
* the request will be sent to the primary region for the account. The primary region is the write region in a
516+
* single master account and the hub region in a multi-master account.
515517
*
516518
* @param excludeRegions list of regions
517519
* @return the {@link CosmosChangeFeedRequestOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosItemRequestOptions.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,8 +401,10 @@ public CosmosItemRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(Co
401401
}
402402

403403
/**
404-
* List of regions to exclude for the request/retries. Example "East US" or "East US, West US"
405-
* These regions will be excluded from the preferred regions list
404+
* List of regions to be excluded for the request/retries. Example "East US" or "East US, West US"
405+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
406+
* the request will be sent to the primary region for the account. The primary region is the write region in a
407+
* single master account and the hub region in a multi-master account.
406408
*
407409
* @param excludeRegions list of regions
408410
* @return the {@link CosmosItemRequestOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosQueryRequestOptions.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,9 @@ public CosmosQueryRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(C
216216

217217
/**
218218
* List of regions to be excluded for the request/retries. Example "East US" or "East US, West US"
219-
* These regions will be excluded from the preferred regions list
219+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
220+
* the request will be sent to the primary region for the account. The primary region is the write region in a
221+
* single master account and the hub region in a multi-master account.
220222
*
221223
* @param excludeRegions the regions to exclude
222224
* @return the {@link CosmosQueryRequestOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosReadManyRequestOptions.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ public CosmosReadManyRequestOptions setCosmosEndToEndOperationLatencyPolicyConfi
138138

139139
/**
140140
* List of regions to be excluded for the request/retries. Example "East US" or "East US, West US"
141-
* These regions will be excluded from the preferred regions list
141+
* These regions will be excluded from the preferred regions list. If all the regions are excluded,
142+
* the request will be sent to the primary region for the account. The primary region is the write region in a
143+
* single master account and the hub region in a multi-master account.
142144
*
143145
* @param excludeRegions the regions to exclude
144146
* @return the {@link CosmosReadManyRequestOptions}

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosRequestOptions.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ public CosmosRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRe
9494
}
9595

9696
/**
97-
* Sets the exclude regions.
97+
* Sets the exclude regions. If all the regions are excluded, the request will be sent to the primary region
98+
* for the account. The primary region is the write region in a single master account and the hub region
99+
* in a multi-master account.
98100
*
99101
* @param excludeRegions the ExcludeRegions.
100102
* @return current CosmosRequestOptions.

0 commit comments

Comments
 (0)