All Classes and Interfaces
Class
Description
The type Availability strategy.
Indicates functionality that is in preview and as such is subject to change in non-backwards compatible ways in future releases,
including removal, regardless of any compatibility expectations set by the containing library version.
Azure library version numbers
Change Feed response meta data
Change feed operation type
Represents the change feed policy configuration for the container in the Azure Cosmos DB service.
Simple host for distributing change feed events across observers, simplifying the process of reading the change feeds
and distributing the processing events across multiple consumers effectively.
Helper class to build a
ChangeFeedProcessor
instance.Encapsulates properties which are mapped to a batch of change feed documents
processed when
ChangeFeedProcessorBuilder.handleAllVersionsAndDeletesChanges(BiConsumer)
lambda is invoked.Change Feed processor item.
Specifies the options associated with
ChangeFeedProcessor
.Specifies the
ChangeFeedProcessor
state for a particular lease/worker.Path that needs encryption and the associated settings within
ClientEncryptionPolicy
.Client encryption policy.
Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service.
Represents the sorting order for a path in a composite index, for a
container in the Azure Cosmos DB database service.
Represents a computed property definition for a Cosmos DB container.
The enum Conflict resolution mode.
Represents the conflict resolution policy configuration for specifying how to resolve conflicts
in case writes from different regions result in conflicts on items in the container in the Azure Cosmos DB
service.
Represents the connection mode to be used by the client in the Azure Cosmos DB database service.
Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service.
Specifies the kind of resource that has a Cosmos container as parent resource.
Provides a client-side logical representation of the Azure Cosmos DB service.
The type Cosmos async clientEncryptionKey.
Read and delete conflicts
Provides methods for reading, deleting, and replacing existing Containers.
Perform read and delete databases, update database throughput, and perform operations on child resources
Has methods to operate on a per-User Permission to access a specific resource
The type Cosmos async scripts.
The type Cosmos async stored procedure.
The type Cosmos async trigger.
The type Cosmos async user.
The type Cosmos async user defined function.
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.
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.
Represents a batch of operations against items with the same
PartitionKey
in a container that will be performed
in a Cosmos manner at the Azure Cosmos DB service.Encapsulates options that can be specified for an operation within a
CosmosBatch
.Represents a result for a specific operation that was part of a
CosmosBatch
request.Encapsulates options that can be specified for an operation within a
CosmosBatch
.Encapsulates options that can be specified for a
CosmosBatch
.Response of a
CosmosBatch
request.Encapsulates options that can be specified for operations used in Bulk execution.
Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
Encapsulates options that can be specified for an operation used in Bulk execution.
Response of a
CosmosItemOperation
request when processed using Bulk by calling
CosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
.Request, response and the exception(if any) for a
CosmosItemOperation
request when processed using Bulk by calling
CosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
.Utility for creating bulk operations which can be executed by calling
CosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
.Encapsulates options that can be specified for an patch operation used in Bulk execution.
Encapsulates options that can be specified for an operation within a change feed request.
Provides a client-side logical representation of the Azure Cosmos DB service.
Helper class to build
CosmosAsyncClient
and CosmosClient
instances as logical representation of the Azure Cosmos database service.The type Cosmos clientEncryptionKey.
Details of an encryption key for use with the Azure Cosmos DB service.
The type Cosmos client encryption key response.
Class with config options for Cosmos Client telemetry
The type Cosmos conflict properties.
The type Cosmos conflict request options.
The type Cosmos conflict response.
Provides synchronous methods for reading, deleting, and replacing existing Containers
Provides methods for interacting with child resources (Items, Scripts, Conflicts)
Encapsulates the container link associated with the container.
Encapsulates the list of container identities and no. of proactive connection regions.
A builder to build
CosmosContainerProactiveInitConfig
Represents a container in the Azure Cosmos DB database service.
Encapsulates options that can be specified for a request issued to Cosmos container.
The type Cosmos container response.
Perform read and delete databases, update database throughput, and perform operations on child resources in
a synchronous way
Represents a CosmosAsyncDatabase in the Azure Cosmos database service.
Encapsulates options that can be specified for a request issued to cosmos database.
The type Cosmos database response.
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB
This class provides metadata for an operation in the Cosmos DB SDK that can be used
by diagnostic handlers
And interface that can be implemented to add custom diagnostic processors
This class represents diagnostic information for different steps in the request pipeline when
processing a data plane request (for example to issue a point operation against a certain replica).
This class represents diagnostic information for transport requests (calls to a replica in direct mode, calls to
the Gateway for example to get metadata like physical addresses of replica for a partition.
This class describes the thresholds when more details diagnostics are emitted for an operation due to high latency,
high RU consumption or high payload sizes.
Represents End to end operation latency policy config
This enables requests to get cancelled by the client once the specified timeout is reached
Builder for CosmosEndToEndOperationLatencyPolicyConfig
This class defines a custom exception type for all operations on
CosmosClient in the Azure Cosmos DB database service.
A class which encapsulates a set of excluded regions.
Represents cosmos full text index of the IndexingPolicy in the Azure Cosmos DB database service.
Path settings within
CosmosFullTextPolicy
Full Text Search Policy
Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItem
Encapsulates Cosmos Item Operation
Depicts type of Cosmos Item Operation
Encapsulates options that can be specified for a request issued to cosmos Item.
The type Cosmos item response.
The
CosmosItemSerializer
allows customizing the serialization of Cosmos Items - either to transform payload (for
example wrap/unwrap in custom envelopes) or use custom serialization settings or json serializer stacks.Categories for Cosmos DB client-side metrics
Names of Cosmos DB client-side meters
The tag names that can be used for Cosmos client-side meters.
Options of a Cosmos client-side meter that can be used to enable/disable it, change the percentile and histogram
capturing (if percentiles are applicable for the meter) and allows suppressing tags that are not desired.
Micrometer-specific Azure Cosmos DB SDK metrics options
Encapsulates the details of an operation and allows for overriding some properties in the internal request options.
Represents a policy that can be used with
CosmosClientBuilder
to customize the request sent to Azure Cosmos DB.Cosmos implementation of
ContinuablePagedFlux
.Cosmos implementation of
ContinuablePagedIterable
.Encapsulates options for
CosmosPatchOperations
Grammar is a super set of this RFC: https://tools.ietf.org/html/rfc6902#section-4.1
Contains a list of Patch operations to be applied on an item.
The type Cosmos permission properties.
Contains the request options of CosmosAsyncPermission
The type Cosmos permission response.
Specifies the options associated with query methods (enumeration operations)
in the Azure Cosmos DB database service.
Specifies the options associated with read many operation
in the Azure Cosmos DB database service.
CosmosRegionSwitchHint
encapsulates hints which guide SDK-internal
retry policies on how early to switch retries to a different region.Getters for the common request context for operations in CosmosDB.
The common request options for operations.
The cosmos response
The type Cosmos sync scripts.
The type Cosmos sync stored procedure.
Represents a stored procedure in the Azure Cosmos DB database service.
Encapsulates options that can be specified for a request issued to cosmos stored procedure.
The type Cosmos stored procedure response.
The type Cosmos sync trigger.
The type Cosmos trigger properties.
The type Cosmos trigger response.
The type Cosmos sync user.
The type Cosmos sync user defined function.
The type Cosmos user defined function properties.
The type Cosmos user defined function response.
The Cosmos user properties.
The type Cosmos user response.
Data types for the embeddings in Cosmos DB database service.
Distance Function for the embeddings in the Cosmos DB database service.
Embedding settings within
CosmosVectorEmbeddingPolicy
Vector Embedding Policy
Vector Indexes spec for Azure CosmosDB service.
Defines the index type of vector index specification in the Azure Cosmos DB service.
Dedicated Gateway Request Options
Represents the connection config with
ConnectionMode.DIRECT
associated with Cosmos Client in the Azure Cosmos DB database service.Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.
Represents an excluded path of the IndexingPolicy in the Azure Cosmos DB database service.
Represents a feed range.
The type Feed response.
Represents the connection config with
ConnectionMode.GATEWAY
associated with Cosmos Client in the Azure Cosmos DB database service.This configuration is used for throughput global control mode.
Throughput global control config builder.
Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service.
Specifies whether or not the resource is to be indexed in the Azure Cosmos DB database service.
Specifies the supported indexing modes in the Azure Cosmos DB database service.
Represents the indexing policy configuration for a container in the Azure Cosmos DB database service.
Class to define the options for non-idempotent write operations
Represents a partition key value in the Azure Cosmos DB database service.
Builder for partition keys.
Represents a partition key definition in the Azure Cosmos DB database service.
Partitioning version.
Specifies the partition scheme for a multiple-partitioned container in the Azure Cosmos DB database service.
Enumeration specifying applicability of permission in the Azure Cosmos DB database service.
Enumeration specifying Priority Level of requests
SessionRetryOptions
encapsulates hints which influence
internal retry policies which are applied when the effective consistency
used for the request is Session Consistency.A
SessionRetryOptionsBuilder
instance will be used to build
a SessionRetryOptions
instance.Defines whether to print db.statement in tracing.
The type Spatial spec.
Defines the target data type of an index path specification in the Azure Cosmos DB service.
Represents a SQL parameter in the SqlQuerySpec used for queries in the Azure Cosmos DB database service.
Represents a SQL query in the Azure Cosmos DB database service.
The type Threshold based retry availability strategy.
Encapsulates retry options in the Azure Cosmos DB database service.
Throughput control group configuration.
The throughput control group config builder.
Represents throughput of the resources in the Azure Cosmos DB service.
The cosmos throughput response.
Specifies the operations on which a trigger should be executed in the Azure Cosmos DB database service.
The trigger type in the Azure Cosmos DB database service.
Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos
DB service.
Represents the unique key policy configuration for specifying uniqueness constraints on items in the
container in the Azure Cosmos DB service.