Package com.azure.data.cosmos

This package provides Rx interfaces for interacting with Azure Cosmos DB.

Interface Summary

Interface	Description
ChangeFeedProcessor	Simple host for distributing change feed events across observers and thus allowing these observers scale.
ChangeFeedProcessor.BuilderDefinition	The ChangeFeedProcessor builder definitions for setting the properties.
TokenResolver	This interface is for client side implementation, which can be used for initializing AsyncDocumentClient 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 AsyncDocumentClient per application shared across various users with different resource permissions.

Class Summary

Class	Description
AccessCondition	Represents a set of access conditions to be used for operations against the Azure Cosmos DB database service.
ChangeFeedOptions	Specifies the options associated with change feed methods (enumeration operations) in the Azure Cosmos DB database service.
ChangeFeedProcessorOptions	Specifies the options associated with ChangeFeedProcessor.
CompositePath	Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service.
ConflictResolutionPolicy	Represents the conflict resolution policy configuration for specifying how to resolve conflicts in case writes from different regions result in conflicts on documents in the collection in the Azure Cosmos DB service.
ConnectionPolicy	Represents the Connection policy associated with a DocumentClient in the Azure Cosmos DB database service.
ConsistencyPolicy	Encapsulates the properties for consistency policy in the Azure Cosmos DB database service.
CosmosClient	Provides a client-side logical representation of the Azure Cosmos database service.
CosmosClientBuilder	Helper class to build CosmosClient instances as logical representation of the Azure Cosmos database service.
CosmosConflict	Read and delete conflicts
CosmosConflictProperties
CosmosConflictRequestOptions
CosmosConflictResponse
CosmosContainer	Provides methods for reading, deleting, and replacing existing Containers.
CosmosContainerProperties	Represents a item container in the Azure Cosmos DB database service.
CosmosContainerRequestOptions	Encapsulates options that can be specified for a request issued to cosmos container.
CosmosContainerResponse
CosmosDatabase	Perform read and delete databases, update database throughput, and perform operations on child resources
CosmosDatabaseProperties	Represents a CosmosDatabase in the Azure Cosmos database service.
CosmosDatabaseRequestOptions	Encapsulates options that can be specified for a request issued to cosmos database.
CosmosDatabaseResponse
CosmosError	Encapsulates error related details in the Azure Cosmos DB database service.
CosmosItem
CosmosItemProperties
CosmosItemRequestOptions	Encapsulates options that can be specified for a request issued to cosmos Item.
CosmosItemResponse
CosmosKeyCredential	Cosmos Key Credential is used to store key credentials, in order to support dynamic key rotation.
CosmosPermission
CosmosPermissionProperties
CosmosPermissionRequestOptions	Contains the request options of CosmosPermission
CosmosPermissionResponse
CosmosResponse<T extends Resource>
CosmosResponseDiagnostics	This class represents response diagnostic statistics associated with a request to Azure Cosmos DB
CosmosScripts
CosmosStoredProcedure
CosmosStoredProcedureProperties
CosmosStoredProcedureRequestOptions	Encapsulates options that can be specified for a request issued to cosmos stored procedure.
CosmosStoredProcedureResponse
CosmosTrigger
CosmosTriggerProperties
CosmosTriggerResponse
CosmosUser
CosmosUserDefinedFunction
CosmosUserDefinedFunctionProperties
CosmosUserDefinedFunctionResponse
CosmosUserProperties
CosmosUserResponse
DatabaseAccount	Represents a database account in the Azure Cosmos DB database service.
DatabaseAccountLocation	Represents the location of a database account in the Azure Cosmos DB database service.
ExcludedPath	Represents an excluded path of the IndexingPolicy in the Azure Cosmos DB database service.
FeedOptions	Specifies the options associated with feed methods (enumeration operations) in the Azure Cosmos DB database service.
FeedResponse<T>
FeedResponseDiagnostics
HashIndex	Represents a hash index in the Azure Cosmos DB database service.
IncludedPath	Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service.
Index	Represents the index of a collection in the Azure Cosmos DB database service.
IndexingPolicy	Represents the indexing policy configuration for a collection in the Azure Cosmos DB database service.
JsonSerializable	Represents a base resource that can be serialized to JSON in the Azure Cosmos DB database service.
PartitionKey	Represents a partition key value in the Azure Cosmos DB database service.
PartitionKeyDefinition	Represents a partition key definition in the Azure Cosmos DB database service.
RangeIndex	Represents a range index in the Azure Cosmos DB database service.
Resource	Represents the base resource in the Azure Cosmos DB database service.
RetryOptions	Encapsulates retry options in the Azure Cosmos DB database service.
SpatialSpec
SqlParameter	Represents a SQL parameter in the SqlQuerySpec used for queries in the Azure Cosmos DB database service.
SqlParameterList	Represents a collection of SQL parameters to for a SQL query in the Azure Cosmos DB database service.
SqlQuerySpec	Represents a SQL query in the Azure Cosmos DB database service.
UniqueKey	Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
UniqueKeyPolicy	Represents the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Enum Summary

Enum	Description
AccessConditionType	Specifies the set of access condition types that can be used for operations in the Azure Cosmos DB database service.
CompositePathSortOrder	Represents the sorting order for a path in a composite index, for a collection in the Azure Cosmos DB database service.
ConflictResolutionMode
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 Cosmos DB client operations in the Azure Cosmos DB database service.
CosmosResourceType	Resource types in the Azure Cosmos DB database service.
DataType	Data types in the Azure Cosmos DB database service.
IndexingDirective	Specifies whether or not the resource is to be indexed in the Azure Cosmos DB database service.
IndexingMode	Specifies the supported indexing modes in the Azure Cosmos DB database service.
IndexKind	These are the indexing types available for indexing a path in the Azure Cosmos DB database service.
PartitionKeyDefinitionVersion	Partitioning version.
PartitionKind	Specifies the partition scheme for an multiple-partitioned collection in the Azure Cosmos DB database service.
PermissionMode	Enumeration specifying applicability of permission in the Azure Cosmos DB database service.
SerializationFormattingPolicy	The formatting policy associated with JSON serialization in the Azure Cosmos DB database service.
SpatialType	Defines the target data type of an index path specification in the Azure Cosmos DB service.
TriggerOperation	Specifies the operations on which a trigger should be executed in the Azure Cosmos DB database service.
TriggerType	The trigger type in the Azure Cosmos DB database service.

Exception Summary

Exception	Description
BadRequestException	While this class is public, but it is not part of our published public APIs.
ConflictException	While this class is public, but it is not part of our published public APIs.
CosmosClientException	This class defines a custom exception type for all operations on DocumentClient in the Azure Cosmos DB database service.
ForbiddenException
GoneException
InternalServerErrorException	This exception is thrown when DocumentServiceRequest contains x-ms-documentdb-partitionkeyrangeid header and such range id doesn't exist.
InvalidPartitionException	While this class is public, but it is not part of our published public APIs.
LockedException	While this class is public, but it is not part of our published public APIs.
MethodNotAllowedException
NotFoundException	While this class is public, but it is not part of our published public APIs.
PartitionIsMigratingException	While this class is public, but it is not part of our published public APIs.
PartitionKeyRangeGoneException	This exception is thrown when DocumentServiceRequest contains x-ms-documentdb-partitionkeyrangeid header and such range id doesn't exist.
PartitionKeyRangeIsSplittingException	While this class is public, but it is not part of our published public APIs.
PreconditionFailedException	While this class is public, but it is not part of our published public APIs.
RequestEntityTooLargeException	While this class is public, but it is not part of our published public APIs.
RequestRateTooLargeException
RequestTimeoutException
RetryWithException
ServiceUnavailableException
UnauthorizedException