Promote Full Text Search BETA APIs to GA in azure-cosmos#48538
Open
kushagraThapar wants to merge 5 commits intoAzure:mainfrom
Open
Promote Full Text Search BETA APIs to GA in azure-cosmos#48538kushagraThapar wants to merge 5 commits intoAzure:mainfrom
kushagraThapar wants to merge 5 commits intoAzure:mainfrom
Conversation
Remove @beta annotations from APIs whose service-side features are GA: 1. Full Text Search (GA per service docs): - CosmosContainerProperties.getFullTextPolicy()/setFullTextPolicy() - IndexingPolicy.getCosmosFullTextIndexes()/setCosmosFullTextIndexes() 2. Throughput Control V4_13_0 (GA since 2021): - ThroughputControlGroupConfigBuilder.setGroupName() - ThroughputControlGroupConfigBuilder.setTargetThroughput() - ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold() - ThroughputControlGroupConfigBuilder.setDefault() 3. Deprecated+Beta misc (already deprecated, unrelated to preview features): - CosmosDiagnostics.getRegionsContacted() - EncryptionKeyWrapMetadata(String, String, String) APIs intentionally kept as @beta (service features still in preview): - Change Feed All Versions & Deletes (service preview) - ReadConsistencyStrategy (direct-mode only) - Http2ConnectionConfig (SDK preview) - Throughput Buckets V4_74_0 (service preview) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR promotes a set of previously @Beta-annotated public APIs in azure-cosmos to GA by removing the @Beta annotations (and now-unused Beta imports where applicable), aligning the Java SDK surface with GA service functionality.
Changes:
- Removed
@Betafrom Full Text Search accessors onCosmosContainerPropertiesandIndexingPolicy. - Removed
@Betafrom several deprecated Throughput Control builder setters and a deprecated diagnostics accessor. - Updated the
azure-cosmoschangelog to note the GA promotion.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/IndexingPolicy.java | Removes @Beta from full text index accessors and drops the unused Beta import. |
| sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerProperties.java | Removes @Beta from getFullTextPolicy/setFullTextPolicy. |
| sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/ThroughputControlGroupConfigBuilder.java | Removes @Beta from deprecated builder setters for throughput control group configuration. |
| sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosDiagnostics.java | Removes @Beta from deprecated getRegionsContacted() and drops the unused Beta import. |
| sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/EncryptionKeyWrapMetadata.java | Removes @Beta from deprecated constructor and drops the unused Beta import. |
| sdk/cosmos/azure-cosmos/CHANGELOG.md | Notes the GA promotion in release history. |
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/IndexingPolicy.java
Outdated
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosContainerProperties.java
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/ThroughputControlGroupConfigBuilder.java
Show resolved
Hide resolved
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/IndexingPolicy.java
Show resolved
Hide resolved
tvaron3
reviewed
Mar 23, 2026
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/EncryptionKeyWrapMetadata.java
Show resolved
Hide resolved
- IndexingPolicy: getter javadoc says 'indexes' not 'paths', setter @return says 'IndexingPolicy' not 'excluded paths' - CosmosContainerProperties: setFullTextPolicy javadoc says 'Sets' not 'Gets' - ThroughputControlGroupConfigBuilder: fix grammar 'should between' → 'should be between' in both exception messages Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep @beta annotation on deprecated APIs so they can be removed later if needed. Only Full Text Search APIs (getFullTextPolicy, setFullTextPolicy, getCosmosFullTextIndexes, setCosmosFullTextIndexes) are promoted to GA since their underlying service feature is GA. Restored @beta on: - CosmosDiagnostics.getRegionsContacted() (V4_9_0) - ThroughputControlGroupConfigBuilder.setGroupName/setTargetThroughput/ setTargetThroughputThreshold/setDefault (V4_13_0) - EncryptionKeyWrapMetadata 3-arg constructor (V4_16_0) Updated changelog to reflect reduced GA scope. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
kushagraThapar
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Promote Full Text Search BETA APIs to GA in azure-cosmos
Motivation
The Java SDK has 68
@Beta-annotated public APIs. After cross-referencing each feature area against the Azure Cosmos DB service documentation and comparing with the Python SDK's GA status, 4 Full Text Search APIs are eligible for GA promotion because the underlying service feature is already generally available.Changes
Removed
@Betaannotations from the following Full Text Search APIs:Full Text Search — service feature is GA
CosmosContainerPropertiesgetFullTextPolicy()CosmosContainerPropertiessetFullTextPolicy(CosmosFullTextPolicy)IndexingPolicygetCosmosFullTextIndexes()IndexingPolicysetCosmosFullTextIndexes(List)JavaDoc and grammar fixes (from review)
IndexingPolicy: getter javadoc corrected from "paths" to "indexes", setter@returncorrected from "excluded paths" to "IndexingPolicy"CosmosContainerProperties:setFullTextPolicyjavadoc corrected from "Gets" to "Sets"ThroughputControlGroupConfigBuilder: grammar fix "should between" → "should be between" in exception messagesAPIs intentionally kept as
@Beta@Betaretained on deprecated APIs so they can be removed later if neededLATEST_COMMITTED,GLOBAL_STRONG) beyond standard consistency levels.setEnabled()JavaDoc: "false while in preview, true later".Validation
mvn compilewith checkstyle passes cleanly