com.azure.cosmos
This package provides interfaces for interacting with Azure Cosmos DB.
Classes
| AvailabilityStrategy |
The type Availability strategy. |
| BridgeInternal |
DO NOT USE. |
| ChangeFeedProcessorBuilder |
Helper class to build a ChangeFeedProcessor instance. |
| CosmosAsyncClient |
Provides a client-side logical representation of the Azure Cosmos DB service. |
| CosmosAsyncClientEncryptionKey |
The type Cosmos async client |
| CosmosAsyncConflict |
Read and delete conflicts |
| CosmosAsyncContainer |
Provides methods for reading, deleting, and replacing existing Containers. |
| CosmosAsyncDatabase |
Perform read and delete databases, update database throughput, and perform operations on child resources |
| CosmosAsyncPermission |
Has methods to operate on a per-User Permission to access a specific resource |
| CosmosAsyncScripts |
The type Cosmos async scripts. |
| CosmosAsyncStoredProcedure |
The type Cosmos async stored procedure. |
| CosmosAsyncTrigger |
The type Cosmos async trigger. |
| CosmosAsyncUser |
The type Cosmos async user. |
| CosmosAsyncUserDefinedFunction |
The type Cosmos async user defined function. |
| CosmosBridgeInternal |
DO NOT USE. |
| CosmosClient |
Provides a client-side logical representation of the Azure Cosmos DB service. |
| CosmosClientBuilder |
Helper class to build CosmosAsyncClient and CosmosClient instances as logical representation of the Azure Cosmos database service. |
| CosmosClientEncryptionKey |
The type Cosmos client |
| CosmosContainer |
Provides synchronous methods for reading, deleting, and replacing existing Containers Provides methods for interacting with child resources (Items, Scripts, Conflicts) |
| CosmosContainerProactiveInitConfig |
Encapsulates the list of container identities and no. |
| CosmosContainerProactiveInitConfigBuilder |
A builder to build CosmosContainerProactiveInitConfig |
| CosmosDatabase |
Perform read and delete databases, update database throughput, and perform operations on child resources in a synchronous way |
| CosmosDiagnostics |
This class represents response diagnostic statistics associated with a request to Azure Cosmos DB |
| CosmosDiagnosticsContext |
This class provides metadata for an operation in the Cosmos DB SDK that can be used by diagnostic handlers |
| CosmosDiagnosticsRequestEvent |
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). |
| CosmosDiagnosticsRequestInfo |
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. |
| CosmosDiagnosticsThresholds |
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. |
| CosmosEndToEndOperationLatencyPolicyConfig |
Represents End to end operation latency policy config This enables requests to get cancelled by the client once the specified timeout is reached |
| CosmosEndToEndOperationLatencyPolicyConfigBuilder |
Builder for Cosmos |
| CosmosException |
This class defines a custom exception type for all operations on Cosmos |
| CosmosExcludedRegions |
A class which encapsulates a set of excluded regions. |
| CosmosItemSerializer |
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. |
| CosmosRegionSwitchHint |
CosmosRegionSwitchHint encapsulates hints which guide SDK-internal retry policies on how early to switch retries to a different region. |
| CosmosRequestContext |
Getters for the common request context for operations in CosmosDB. |
| CosmosScripts |
The type Cosmos sync scripts. |
| CosmosStoredProcedure |
The type Cosmos sync stored procedure. |
| CosmosTrigger |
The type Cosmos sync trigger. |
| CosmosUser |
The type Cosmos sync user. |
| CosmosUserDefinedFunction |
The type Cosmos sync user defined function. |
| DirectConnectionConfig |
Represents the connection config with DIRECT associated with Cosmos Client in the Azure Cosmos DB database service. |
| GatewayConnectionConfig |
Represents the connection config with GATEWAY associated with Cosmos Client in the Azure Cosmos DB database service. |
| GlobalThroughputControlConfig |
This configuration is used for throughput global control mode. |
| GlobalThroughputControlConfigBuilder |
Throughput global control config builder. |
| Http2ConnectionConfig |
Represents the http2 connection config associated with Cosmos Client in the Azure Cosmos DB database service. |
| NonIdempotentWriteRetryOptions |
Class to define the options for non-idempotent write operations |
| SessionRetryOptions |
SessionRetryOptions encapsulates hints which influence internal retry policies which are applied when the effective consistency used for the request is Session Consistency. |
| SessionRetryOptionsBuilder |
A SessionRetryOptionsBuilder instance will be used to build a SessionRetryOptions instance. |
| ThresholdBasedAvailabilityStrategy |
The type Threshold based retry availability strategy. |
| ThrottlingRetryOptions |
Encapsulates retry options in the Azure Cosmos DB database service. |
| ThroughputControlGroupConfig |
Throughput control group configuration. |
| ThroughputControlGroupConfigBuilder |
The throughput control group config builder. |
Interfaces
| ChangeFeedProcessor |
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. |
| ChangeFeedProcessorContext |
Encapsulates properties which are mapped to a batch of change feed documents processed when ChangeFeedProcessorBuilder#handleAllVersionsAndDeletesChanges(BiConsumer) lambda is invoked. |
| CosmosDiagnosticsHandler |
And interface that can be implemented to add custom diagnostic processors |
| CosmosOperationPolicy |
Represents a policy that can be used with CosmosClientBuilder to customize the request sent to Azure Cosmos DB. |
Enums
| ConnectionMode |
Represents the connection mode to be used by the client in the Azure Cosmos DB database service. |
| ConsistencyLevel |
Represents the consistency levels supported for Azure Cosmos DB client operations in the Azure Cosmos DB service. |
| ReadConsistencyStrategy |
Represents the read consistency strategies supported by the Azure Cosmos DB service. |
