Uses of Class
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 Class Description class
CosmosAsyncClientEncryptionKey
The type Cosmos async clientEncryptionKey.class
CosmosClientEncryptionKey
The type Cosmos clientEncryptionKey.class
GlobalThroughputControlConfig
This configuration is used for throughput global control mode.class
GlobalThroughputControlConfigBuilder
Throughput global control config builder.class
ThroughputControlGroupConfig
Throughput control group configuration.class
ThroughputControlGroupConfigBuilder
The throughput control group config builder.Methods in com.azure.cosmos with annotations of type Beta Modifier and Type Method Description CosmosClientBuilder
CosmosClientBuilder. authorizationTokenResolver(CosmosAuthorizationTokenResolver cosmosAuthorizationTokenResolver)
Sets the token resolverGlobalThroughputControlConfig
GlobalThroughputControlConfigBuilder. build()
Validate the throughput global control configuration and create a new throughput global control config item.ThroughputControlGroupConfig
ThroughputControlGroupConfigBuilder. build()
Validate the throughput configuration and create a new throughput control group config item.Mono<CosmosClientEncryptionKeyResponse>
CosmosAsyncDatabase. createClientEncryptionKey(CosmosClientEncryptionKeyProperties keyProperties)
Creates a client encryption key after subscription the operation will be performed.GlobalThroughputControlConfigBuilder
CosmosAsyncClient. createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)
Create global throughput control config builder which will be used to buildGlobalThroughputControlConfig
.GlobalThroughputControlConfigBuilder
CosmosClient. createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)
Create global throughput control config builder which will be used to buildGlobalThroughputControlConfig
.Mono<CosmosItemResponse<Object>>
CosmosAsyncContainer. deleteAllItemsByPartitionKey(PartitionKey partitionKey, CosmosItemRequestOptions options)
Deletes all items in the Container with the specified partitionKey value.CosmosItemResponse<Object>
CosmosContainer. deleteAllItemsByPartitionKey(PartitionKey partitionKey, CosmosItemRequestOptions options)
Deletes all items in the Container with the specified partitionKey value.void
CosmosAsyncContainer. enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig, GlobalThroughputControlConfig globalControlConfig)
Enable the throughput control group with global control mode.void
CosmosContainer. enableGlobalThroughputControlGroup(ThroughputControlGroupConfig groupConfig, GlobalThroughputControlConfig globalControlConfig)
Enable the throughput control group with global control mode.void
CosmosAsyncContainer. enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig)
Enable the throughput control group with local control mode.void
CosmosContainer. enableLocalThroughputControlGroup(ThroughputControlGroupConfig groupConfig)
Enable the throughput control group with local control mode.CosmosAsyncClientEncryptionKey
CosmosAsyncDatabase. getClientEncryptionKey(String id)
Gets a CosmosAsyncClientEncryptionKey object without making a service callCosmosClientEncryptionKey
CosmosDatabase. getClientEncryptionKey(String id)
Gets a CosmosClientEncryptionKey object without making a service callSet<String>
CosmosDiagnostics. getContactedRegionNames()
Regions contacted for this requestDuration
GlobalThroughputControlConfig. getControlItemExpireInterval()
Get the control item expire interval.Duration
GlobalThroughputControlConfig. getControlItemRenewInterval()
Get the control item renew interval.Mono<List<FeedRange>>
CosmosAsyncContainer. getFeedRanges()
Obtains a list ofFeedRange
that can be used to parallelize Feed operations.List<FeedRange>
CosmosContainer. getFeedRanges()
Obtains a list ofFeedRange
that can be used to parallelize Feed operations.String
ThroughputControlGroupConfig. getGroupName()
Get the throughput control group name.String
CosmosAsyncClientEncryptionKey. getId()
Get the id of theCosmosAsyncClientEncryptionKey
String
CosmosClientEncryptionKey. getId()
Get the id of theCosmosClientEncryptionKey
Set<URI>
CosmosDiagnostics. getRegionsContacted()
Deprecated.Integer
ThroughputControlGroupConfig. getTargetThroughput()
Get throughput control group target throughput.Double
ThroughputControlGroupConfig. getTargetThroughputThreshold()
Get the throughput control group target throughput threshold.boolean
ThroughputControlGroupConfig. isDefault()
Get whether this throughput control group will be used by default.Mono<Void>
CosmosAsyncContainer. openConnectionsAndInitCaches()
Initializes the container by warming up the caches and connections for the current read region.void
CosmosContainer. openConnectionsAndInitCaches()
Initializes the container by warming up the caches and connections for the current read region.<T> CosmosPagedFlux<T>
CosmosAsyncContainer. queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType)
Query for items in the change feed of the current container using theCosmosChangeFeedRequestOptions
.<T> CosmosPagedIterable<T>
CosmosContainer. queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType)
Query for items in the change feed of the current container using theCosmosChangeFeedRequestOptions
.CosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. queryClientEncryptionKeys(SqlQuerySpec querySpec)
Query for cosmos client encryption keys in a database.CosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. queryClientEncryptionKeys(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)
Query for cosmos client encryption keys in a database.CosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. queryClientEncryptionKeys(String query)
Query for cosmos client encryption keys in a database.CosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. queryClientEncryptionKeys(String query, CosmosQueryRequestOptions options)
Query for cosmos client encryption keys in a database.Mono<CosmosClientEncryptionKeyResponse>
CosmosAsyncClientEncryptionKey. read()
Reads a cosmos client encryption keyCosmosClientEncryptionKeyResponse
CosmosClientEncryptionKey. read()
Reads a cosmos client encryption keyCosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. readAllClientEncryptionKeys()
Reads all cosmos client encryption keys in a database.CosmosPagedFlux<CosmosClientEncryptionKeyProperties>
CosmosAsyncDatabase. readAllClientEncryptionKeys(CosmosQueryRequestOptions options)
Reads all cosmos client encryption keys in a database.CosmosPagedIterable<CosmosClientEncryptionKeyProperties>
CosmosDatabase. readAllClientEncryptionKeys()
Reads all cosmos client encryption keys in a database.Mono<CosmosClientEncryptionKeyResponse>
CosmosAsyncClientEncryptionKey. replace(CosmosClientEncryptionKeyProperties keyProperties)
Replace a cosmos client encryption key.GlobalThroughputControlConfigBuilder
GlobalThroughputControlConfigBuilder. setControlItemExpireInterval(Duration controlItemExpireInterval)
Set the control item expire interval.GlobalThroughputControlConfigBuilder
GlobalThroughputControlConfigBuilder. setControlItemRenewInterval(Duration controlItemRenewInterval)
Set the control item renew interval.ThroughputControlGroupConfigBuilder
ThroughputControlGroupConfigBuilder. setDefault(boolean aDefault)
Set whether this throughput control group will be used by default.ThroughputControlGroupConfigBuilder
ThroughputControlGroupConfigBuilder. setGroupName(String groupName)
Set the throughput control group name.ThroughputControlGroupConfigBuilder
ThroughputControlGroupConfigBuilder. setTargetThroughput(int targetThroughput)
Set the throughput control group target throughput.ThroughputControlGroupConfigBuilder
ThroughputControlGroupConfigBuilder. setTargetThroughputThreshold(double targetThroughputThreshold)
Set the throughput control group target throughput threshold. -
Uses of Beta in com.azure.cosmos.models
Classes in com.azure.cosmos.models with annotations of type Beta Modifier and Type Class Description class
ChangeFeedPolicy
Represents the change feed policy configuration for the container in the Azure Cosmos DB service.class
ClientEncryptionIncludedPath
Path that needs encryption and the associated settings withinClientEncryptionPolicy
.class
ClientEncryptionPolicy
Client encryption policy.interface
CosmosAuthorizationTokenResolver
This interface is for client side implementation, which can be used for initializing CosmosAsyncClient without passing master key, resource token and permission feed.
Each time the SDK create request for CosmosDB, authorization token is generated based on that request at client side which enables creation of one CosmosAsyncClient per application shared across various users with different resource permissions.class
CosmosChangeFeedRequestOptions
Encapsulates options that can be specified for an operation within a change feed request.class
CosmosClientEncryptionKeyProperties
Details of an encryption key for use with the Azure Cosmos DB service.class
CosmosClientEncryptionKeyResponse
The type Cosmos client encryption key response.class
DedicatedGatewayRequestOptions
Dedicated Gateway Request Optionsclass
EncryptionKeyWrapMetadata
Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.interface
FeedRange
Represents a feed range.class
PartitionKeyBuilder
Builder for partition keys.Methods in com.azure.cosmos.models with annotations of type Beta Modifier and Type Method Description PartitionKeyBuilder
PartitionKeyBuilder. add(boolean value)
Adds partition value of type booleanPartitionKeyBuilder
PartitionKeyBuilder. add(double value)
Adds partition value of type doublePartitionKeyBuilder
PartitionKeyBuilder. add(String value)
Adds partition value of type stringPartitionKeyBuilder
PartitionKeyBuilder. addNoneValue()
Adds a None Partition KeyPartitionKeyBuilder
PartitionKeyBuilder. addNullValue()
Adds a null partition key valuePartitionKey
PartitionKeyBuilder. build()
Builds a new instance of the type PartitionKey with the specified Partition Key values.static CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. createForProcessingFromBeginning(FeedRange feedRange)
Creates a newCosmosChangeFeedRequestOptions
instance to start processing change feed items from the beginning of the change feedstatic CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. createForProcessingFromContinuation(String continuation)
Creates a newCosmosChangeFeedRequestOptions
instance to start processing change feed items from a previous continuationstatic CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. createForProcessingFromNow(FeedRange feedRange)
Creates a newCosmosChangeFeedRequestOptions
instance to start processing change feed items from the current time - so only events for all future changes will be retrievedstatic CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. createForProcessingFromPointInTime(Instant pointInTime, FeedRange feedRange)
Creates a newCosmosChangeFeedRequestOptions
instance to start processing change feed items from a certain point in timestatic ChangeFeedPolicy
ChangeFeedPolicy. createFullFidelityPolicy(Duration retentionDuration)
Creates a ChangeFeedPolicy with retention duration for full fidelity processingstatic ChangeFeedPolicy
ChangeFeedPolicy. createIncrementalPolicy()
Creates a default ChangeFeedPolicy without retention duration specified.static FeedRange
FeedRange. forFullRange()
Creates a range for an entire containerstatic FeedRange
FeedRange. forLogicalPartition(PartitionKey partitionKey)
Creates a range for a certain logical partitionstatic FeedRange
FeedRange. fromString(String json)
Creates a range from a previously obtained string representation.CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. fullFidelity()
Changes the change feed mode so that the change feed will contain events for creations, deletes as well as all intermediary snapshots for updates.String
EncryptionKeyWrapMetadata. getAlgorithm()
Serialized form of metadata.ChangeFeedPolicy
CosmosContainerProperties. getChangeFeedPolicy()
Gets the changeFeedPolicy for this container in the Azure Cosmos DB service.String
ClientEncryptionIncludedPath. getClientEncryptionKeyId()
Gets the identifier of the Data Encryption Key to be used to encrypt the path.ClientEncryptionPolicy
CosmosContainerProperties. getClientEncryptionPolicy()
Gets the ClientEncryptionPolicy that is used for encrypting item fieldsDedicatedGatewayRequestOptions
CosmosItemRequestOptions. getDedicatedGatewayRequestOptions()
Gets the Dedicated Gateway Request OptionsDedicatedGatewayRequestOptions
CosmosQueryRequestOptions. getDedicatedGatewayRequestOptions()
Gets the Dedicated Gateway Request OptionsString
ClientEncryptionIncludedPath. getEncryptionAlgorithm()
Gets the type of encryption algorithm to be performed.String
CosmosClientEncryptionKeyProperties. getEncryptionAlgorithm()
Gets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.EncryptionKeyWrapMetadata
CosmosClientEncryptionKeyProperties. getEncryptionKeyWrapMetadata()
Gets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.String
ClientEncryptionIncludedPath. getEncryptionType()
Gets the type of encryption to be performed.String
CosmosClientEncryptionKeyProperties. getETag()
Get the entity tag associated with the resource.FeedRange
CosmosChangeFeedRequestOptions. getFeedRange()
Gets the feed range.FeedRange
CosmosQueryRequestOptions. getFeedRange()
Gets theFeedRange
Duration
ChangeFeedPolicy. getFullFidelityRetentionDuration()
Gets the retention duration in which it will be possible to process change feed events with full fidelity mode (meaning intermediary changes and deletes will be exposed in change feed).String
CosmosClientEncryptionKeyProperties. getId()
Gets the name of the resource.List<ClientEncryptionIncludedPath>
ClientEncryptionPolicy. getIncludedPaths()
Gets the list of path of the item that need encryption along with path-specific settings.Duration
DedicatedGatewayRequestOptions. getMaxIntegratedCacheStaleness()
Gets the staleness value associated with the request in the Azure CosmosDB service.int
CosmosChangeFeedRequestOptions. getMaxItemCount()
Gets the maximum number of items to be returned in the enumeration operation.int
CosmosChangeFeedRequestOptions. getMaxPrefetchPageCount()
Gets the maximum number of pages that will be prefetched from the backend asynchronously in the background.String
EncryptionKeyWrapMetadata. getName()
Serialized form of metadata.String
ClientEncryptionIncludedPath. getPath()
Gets the path to be encrypted.int
ClientEncryptionPolicy. getPolicyFormatVersion()
Version of the client encryption policy definition.CosmosClientEncryptionKeyProperties
CosmosClientEncryptionKeyResponse. getProperties()
Gets the cosmos client encryption key propertiesScheduler
ChangeFeedProcessorOptions. getScheduler()
Gets the internalScheduler
that hosts a pool of ExecutorService-based workers for any change feed processor related tasks.String
CosmosChangeFeedRequestOptions. getThroughputControlGroupName()
Get the throughput control group name.String
CosmosItemRequestOptions. getThroughputControlGroupName()
Gets the throughput control group name.String
CosmosQueryRequestOptions. getThroughputControlGroupName()
Get throughput control group name.Instant
CosmosClientEncryptionKeyProperties. getTimestamp()
Get the last modified timestamp associated with the resource.String
EncryptionKeyWrapMetadata. getType()
Serialized form of metadata.String
EncryptionKeyWrapMetadata. getValue()
Serialized form of metadata.byte[]
CosmosClientEncryptionKeyProperties. getWrappedDataEncryptionKey()
Gets the wrapped form of the client encryption key.boolean
CosmosChangeFeedRequestOptions. isQuotaInfoEnabled()
Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.CosmosContainerProperties
CosmosContainerProperties. setChangeFeedPolicy(ChangeFeedPolicy value)
Sets the changeFeedPolicy for this container in the Azure Cosmos DB service.ClientEncryptionIncludedPath
ClientEncryptionIncludedPath. setClientEncryptionKeyId(String clientEncryptionKeyId)
Sets the identifier of the Data Encryption Key to be used to encrypt the path.CosmosContainerProperties
CosmosContainerProperties. setClientEncryptionPolicy(ClientEncryptionPolicy value)
Sets the ClientEncryptionPolicy that is used for encrypting item fieldsCosmosItemRequestOptions
CosmosItemRequestOptions. setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
Sets the Dedicated Gateway Request OptionsCosmosQueryRequestOptions
CosmosQueryRequestOptions. setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
Sets the Dedicated Gateway Request OptionsClientEncryptionIncludedPath
ClientEncryptionIncludedPath. setEncryptionAlgorithm(String encryptionAlgorithm)
Sets the type of encryption algorithm to be performed.CosmosClientEncryptionKeyProperties
CosmosClientEncryptionKeyProperties. setEncryptionAlgorithm(String encryptionAlgorithm)
Sets the encryption algorithm that will be used along with this client encryption key to encrypt/decrypt data.CosmosClientEncryptionKeyProperties
CosmosClientEncryptionKeyProperties. setEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)
Sets the metadata for the wrapping provider that can be used to unwrap the wrapped client encryption key.ClientEncryptionIncludedPath
ClientEncryptionIncludedPath. setEncryptionType(String encryptionType)
Sets the type of encryption to be performed.CosmosQueryRequestOptions
CosmosQueryRequestOptions. setFeedRange(FeedRange feedRange)
Sets theFeedRange
that we want to queryCosmosClientEncryptionKeyProperties
CosmosClientEncryptionKeyProperties. setId(String id)
Sets the name of the resource.DedicatedGatewayRequestOptions
DedicatedGatewayRequestOptions. setMaxIntegratedCacheStaleness(Duration maxIntegratedCacheStaleness)
Sets the staleness value associated with the request in the Azure CosmosDB service.CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. setMaxItemCount(int maxItemCount)
Sets the maximum number of items to be returned in the enumeration operation.CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. setMaxPrefetchPageCount(int maxPrefetchPageCount)
Sets the maximum number of pages that will be prefetched from the backend asynchronously in the background.ClientEncryptionIncludedPath
ClientEncryptionIncludedPath. setPath(String path)
Sets the path to be encrypted.void
CosmosChangeFeedRequestOptions. setQuotaInfoEnabled(boolean quotaInfoEnabled)
Gets the quotaInfoEnabled setting for change feed request in the Azure Cosmos DB database service.ChangeFeedProcessorOptions
ChangeFeedProcessorOptions. setScheduler(Scheduler scheduler)
Sets the internalScheduler
that hosts a pool of ExecutorService-based workers for any change feed processor related tasks.CosmosChangeFeedRequestOptions
CosmosChangeFeedRequestOptions. setThroughputControlGroupName(String throughputControlGroupName)
Set the throughput control group name.void
CosmosItemRequestOptions. setThroughputControlGroupName(String throughputControlGroupName)
Sets the throughput control group name.CosmosQueryRequestOptions
CosmosQueryRequestOptions. setThroughputControlGroupName(String throughputControlGroupName)
Set the throughput control group name.CosmosClientEncryptionKeyProperties
CosmosClientEncryptionKeyProperties. setWrappedDataEncryptionKey(byte[] wrappedDataEncryptionKey)
Sets the wrapped form of the client encryption key.String
FeedRange. toString()
Gets a json representation of the feed range - the returned json string can be used to create a new feed range instance from it - (use factory method fromJsonString to do so)Constructors in com.azure.cosmos.models with annotations of type Beta Constructor Description ClientEncryptionPolicy(List<ClientEncryptionIncludedPath> paths)
Constructor.CosmosClientEncryptionKeyProperties(String id, String encryptionAlgorithm, byte[] wrappedDataEncryptionKey, EncryptionKeyWrapMetadata encryptionKeyWrapMetadata)
Constructor.DedicatedGatewayRequestOptions()
ConstructorEncryptionKeyWrapMetadata()
For JSON deserializeEncryptionKeyWrapMetadata(EncryptionKeyWrapMetadata source)
Creates a new instance of key wrap metadata based on an existing instance.EncryptionKeyWrapMetadata(String type, String name, String value)
Deprecated.EncryptionKeyWrapMetadata(String type, String name, String value, String algorithm)
Creates a new instance of key wrap metadata based on an existing instance.PartitionKeyBuilder()
Constructor.
-