Uses of Annotation Type
com.azure.cosmos.util.Beta

Packages that use Beta

Package	Description
com.azure.cosmos	This package provides interfaces for interacting with Azure Cosmos DB.
com.azure.cosmos.models	This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.

Uses of Beta in com.azure.cosmos

Classes in com.azure.cosmos with annotations of type Beta

Modifier and Type	Interface	Description
interface	ChangeFeedProcessorContext	Encapsulates properties which are mapped to a batch of change feed documents processed when ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges(BiConsumer) lambda is invoked.
class	Http2ConnectionConfig	Represents the http2 connection config associated with Cosmos Client in the Azure Cosmos DB database service.
enum	ReadConsistencyStrategy	Represents the read consistency strategies supported by the Azure Cosmos DB service.

Methods in com.azure.cosmos with annotations of type Beta

Modifier and Type	Method	Description
default CosmosDiagnosticsContext	ChangeFeedProcessorContext.getDiagnostics()	Get the diagnostics context from the underlying feed response.
Http2ConnectionConfig	GatewayConnectionConfig.getHttp2ConnectionConfig()	Get the http2 connection config.
String	ChangeFeedProcessorContext.getLeaseToken()	Gets the lease token corresponding to the source of a batch of change feed documents.
Integer	Http2ConnectionConfig.getMaxConcurrentStreams()	Get the maximum number of the concurrent streams that can be opened to the remote peer.
Integer	Http2ConnectionConfig.getMaxConnectionPoolSize()	Get the maximum number of live connections to keep in the pool.
Integer	Http2ConnectionConfig.getMinConnectionPoolSize()	Get the minimum number of live connections to keep in the pool (can be the best effort).
Set<URI>	CosmosDiagnostics.getRegionsContacted()	Deprecated.
ChangeFeedProcessorBuilder	ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges(BiConsumer<List<ChangeFeedProcessorItem>,ChangeFeedProcessorContext> biConsumer)	Sets a BiConsumer function which will be called to process changes for AllVersionsAndDeletes change feed mode.
ChangeFeedProcessorBuilder	ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges(Consumer<List<ChangeFeedProcessorItem>> consumer)	Sets a consumer function which will be called to process changes for AllVersionsAndDeletes change feed mode.
Boolean	Http2ConnectionConfig.isEnabled()	return the flag to indicate whether http2 is enabled.
CosmosClientBuilder	CosmosClientBuilder.readConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the ReadConsistencyStrategy to be used by this client for read/query operations by default.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setDefault(boolean aDefault)	Deprecated.
Http2ConnectionConfig	Http2ConnectionConfig.setEnabled(Boolean enabled)	Configure the flag to indicate whether http2 is enabled.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setGroupName(String groupName)	Deprecated.
GatewayConnectionConfig	GatewayConnectionConfig.setHttp2ConnectionConfig(Http2ConnectionConfig http2ConnectionConfig)	Set the http2 connection config.
Http2ConnectionConfig	Http2ConnectionConfig.setMaxConcurrentStreams(Integer maxConcurrentStreams)	Configures the maximum number of the concurrent streams that can be opened to the remote peer.
Http2ConnectionConfig	Http2ConnectionConfig.setMaxConnectionPoolSize(Integer maxConnectionPoolSize)	Configures the maximum number of live connections to keep in the pool.
Http2ConnectionConfig	Http2ConnectionConfig.setMinConnectionPoolSize(Integer minConnectionPoolSize)	Configures the minimum number of live connections to keep in the pool (can be the best effort).
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setTargetThroughput(int targetThroughput)	Deprecated.
ThroughputControlGroupConfigBuilder	ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold(double targetThroughputThreshold)	Deprecated.

Constructors in com.azure.cosmos with annotations of type Beta

Modifier	Constructor	Description
	Http2ConnectionConfig()	The constructor of Http2ConnectionConfig.

Uses of Beta in com.azure.cosmos.models

Classes in com.azure.cosmos.models with annotations of type Beta

Modifier and Type	Class	Description
final class	ChangeFeedMetaData	Change Feed response meta data
enum	ChangeFeedOperationType	Change feed operation type
final class	ChangeFeedPolicy	Represents the change feed policy configuration for the container in the Azure Cosmos DB service.
final class	ChangeFeedProcessorItem	Change Feed processor item.
final class	CosmosFullTextIndex	Represents cosmos full text index of the IndexingPolicy in the Azure Cosmos DB database service.
final class	CosmosFullTextPath	Path settings within CosmosFullTextPolicy
final class	CosmosFullTextPolicy	Full Text Search Policy

Methods in com.azure.cosmos.models with annotations of type Beta

Modifier and Type	Method	Description
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.allVersionsAndDeletes()	Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates.
static ChangeFeedPolicy	ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(Duration retentionDuration)	Creates a ChangeFeedPolicy with retention duration for AllVersionsAndDeletes processing
static ChangeFeedPolicy	ChangeFeedPolicy.createFullFidelityPolicy(Duration retentionDuration)	Deprecated. use ChangeFeedPolicy.createAllVersionsAndDeletesPolicy(Duration) instead.
static ChangeFeedPolicy	ChangeFeedPolicy.createIncrementalPolicy()	Deprecated. use ChangeFeedPolicy.createLatestVersionPolicy() instead.
static ChangeFeedPolicy	ChangeFeedPolicy.createLatestVersionPolicy()	Creates a default ChangeFeedPolicy without retention duration specified.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.fullFidelity()	Deprecated. use CosmosChangeFeedRequestOptions.allVersionsAndDeletes() instead.
ChangeFeedMetaData	ChangeFeedProcessorItem.getChangeFeedMetaData()	Gets the change feed metadata.
ChangeFeedPolicy	CosmosContainerProperties.getChangeFeedPolicy()	Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.
Instant	ChangeFeedMetaData.getConflictResolutionTimestamp()	Gets the conflict resolution timestamp
List<CosmosFullTextIndex>	IndexingPolicy.getCosmosFullTextIndexes()	Gets the full text search paths.
JsonNode	ChangeFeedProcessorItem.getCurrent()	Gets the change feed current item.
String	CosmosFullTextPolicy.getDefaultLanguage()	Gets the default language for cosmosFullText.
Duration	ChangeFeedPolicy.getFullFidelityRetentionDuration()	Deprecated. use ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy() instead
CosmosFullTextPolicy	CosmosContainerProperties.getFullTextPolicy()	Gets the Full Text Policy containing paths for full text search and the language specification for each path.
String	CosmosFullTextPath.getLanguage()	Gets the language for the cosmosFullText path.
long	ChangeFeedMetaData.getLogSequenceNumber()	Gets the current logical sequence number
ChangeFeedOperationType	ChangeFeedMetaData.getOperationType()	Gets the Change Feed operation type
String	CosmosFullTextIndex.getPath()	Gets path.
String	CosmosFullTextPath.getPath()	Gets the path for the cosmosFullText.
List<CosmosFullTextPath>	CosmosFullTextPolicy.getPaths()	Gets the paths for cosmosFulltext.
JsonNode	ChangeFeedProcessorItem.getPrevious()	Gets the change feed previous item.
long	ChangeFeedMetaData.getPreviousLogSequenceNumber()	Gets the previous logical sequence number
ReadConsistencyStrategy	CosmosChangeFeedRequestOptions.getReadConsistencyStrategy()	Gets the read consistency strategy for the request.
ReadConsistencyStrategy	CosmosItemRequestOptions.getReadConsistencyStrategy()	Gets the read consistency strategy for the request.
ReadConsistencyStrategy	CosmosQueryRequestOptions.getReadConsistencyStrategy()	Gets the read consistency strategy for the request.
ReadConsistencyStrategy	CosmosReadManyRequestOptions.getReadConsistencyStrategy()	Gets the read consistency strategy for the request.
ReadConsistencyStrategy	CosmosRequestOptions.getReadConsistencyStrategy()	Gets the read consistency strategy.
Duration	ChangeFeedPolicy.getRetentionDurationForAllVersionsAndDeletesPolicy()	Gets the retention duration in which it will be possible to process change feed events with AllVersionsAndDeletes mode (meaning intermediary changes and deletes will be exposed in change feed).
boolean	ChangeFeedMetaData.isTimeToLiveExpired()	Used to distinguish explicit deletes (e.g. via deleteItem() API) from deletes caused by TTL expiration (a collection may define time-to-live policy for documents).
CosmosContainerProperties	CosmosContainerProperties.setChangeFeedPolicy(ChangeFeedPolicy value)	Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.
IndexingPolicy	IndexingPolicy.setCosmosFullTextIndexes(List<CosmosFullTextIndex> cosmosFullTextIndexes)	Sets the full text search paths.
CosmosFullTextPolicy	CosmosFullTextPolicy.setDefaultLanguage(String defaultLanguage)	Sets the default language for cosmosFullText.
CosmosContainerProperties	CosmosContainerProperties.setFullTextPolicy(CosmosFullTextPolicy value)	Gets the Full Text Policy containing paths for full text search and the language specification for each path.
CosmosFullTextPath	CosmosFullTextPath.setLanguage(String language)	Sets the language for the cosmosFullText path.
CosmosFullTextIndex	CosmosFullTextIndex.setPath(String path)	Sets the path.
CosmosFullTextPath	CosmosFullTextPath.setPath(String path)	Sets the path for the cosmosFullText.
CosmosFullTextPolicy	CosmosFullTextPolicy.setPaths(List<CosmosFullTextPath> paths)	Sets the paths for cosmosFulltext.
CosmosChangeFeedRequestOptions	CosmosChangeFeedRequestOptions.setReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the read consistency strategy required for the request.
CosmosItemRequestOptions	CosmosItemRequestOptions.setReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the read consistency strategy required for the request.
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the read consistency strategy required for the request.
CosmosReadManyRequestOptions	CosmosReadManyRequestOptions.setReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the read consistency strategy required for the request.
CosmosRequestOptions	CosmosRequestOptions.setReadConsistencyStrategy(ReadConsistencyStrategy readConsistencyStrategy)	Sets the read consistency strategy.
JsonNode	ChangeFeedProcessorItem.toJsonNode()	Helper API to convert this changeFeedProcessorItem instance to raw JsonNode format.

Constructors in com.azure.cosmos.models with annotations of type Beta

Modifier	Constructor	Description
	CosmosFullTextIndex()	Constructor
	CosmosFullTextPath()	Constructor
	CosmosFullTextPolicy()	Constructor
	EncryptionKeyWrapMetadata(String type, String name, String value)	Deprecated.