com.azure.cosmos.models

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.67.0

This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.

Classes

ChangeFeedMetaData	Change Feed response meta data
ChangeFeedPolicy	Represents the change feed policy configuration for the container in the Azure Cosmos DB service.
ChangeFeedProcessorItem	Change Feed processor item.
ChangeFeedProcessorOptions	Specifies the options associated with ChangeFeedProcessor.
ChangeFeedProcessorState	Specifies the ChangeFeedProcessor state for a particular lease/worker.
ClientEncryptionIncludedPath	Path that needs encryption and the associated settings within ClientEncryptionPolicy.
ClientEncryptionPolicy	Client encryption policy.
CompositePath	Represents a composite path of the IndexingPolicy in the Azure Cosmos DB database service.
ComputedProperty	Represents a computed property definition for a Cosmos DB container.
ConflictResolutionPolicy	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.
CosmosBatch	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.
CosmosBatchItemRequestOptions	Encapsulates options that can be specified for an operation within a CosmosBatch.
CosmosBatchOperationResult	Represents a result for a specific operation that was part of a CosmosBatch request.
CosmosBatchPatchItemRequestOptions	Encapsulates options that can be specified for an operation within a CosmosBatch.
CosmosBatchRequestOptions	Encapsulates options that can be specified for a CosmosBatch.
CosmosBatchResponse	Response of a CosmosBatch request.
CosmosBulkExecutionOptions	Encapsulates options that can be specified for operations used in Bulk execution.
CosmosBulkExecutionThresholdsState	Encapsulates internal state used to dynamically determine max micro batch size for bulk operations.
CosmosBulkItemRequestOptions	Encapsulates options that can be specified for an operation used in Bulk execution.
CosmosBulkItemResponse	Response of a CosmosItemOperation request when processed using Bulk by calling executeBulkOperations(Flux<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions).
CosmosBulkOperationResponse<TContext>	Request, response and the exception(if any) for a CosmosItemOperation request when processed using Bulk by calling executeBulkOperations(Flux<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions).
CosmosBulkOperations	Utility for creating bulk operations which can be executed by calling executeBulkOperations(Flux<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions) .
CosmosBulkPatchItemRequestOptions	Encapsulates options that can be specified for an patch operation used in Bulk execution.
CosmosChangeFeedRequestOptions	Encapsulates options that can be specified for an operation within a change feed request.
CosmosClientEncryptionKeyProperties	Details of an encryption key for use with the Azure Cosmos DB service.
CosmosClientEncryptionKeyResponse	The type Cosmos client encryption key response.
CosmosClientTelemetryConfig	Class with config options for Cosmos Client telemetry
CosmosConflictProperties	The type Cosmos conflict properties.
CosmosConflictRequestOptions	The type Cosmos conflict request options.
CosmosConflictResponse	The type Cosmos conflict response.
CosmosContainerIdentity	Encapsulates the container link associated with the container.
CosmosContainerProperties	Represents a container in the Azure Cosmos DB database service.
CosmosContainerRequestOptions	Encapsulates options that can be specified for a request issued to Cosmos container.
CosmosContainerResponse	The type Cosmos container response.
CosmosDatabaseProperties	Represents a CosmosAsyncDatabase in the Azure Cosmos database service.
CosmosDatabaseRequestOptions	Encapsulates options that can be specified for a request issued to cosmos database.
CosmosDatabaseResponse	The type Cosmos database response.
CosmosFullTextIndex	Represents cosmos full text index of the IndexingPolicy in the Azure Cosmos DB database service.
CosmosFullTextPath	Path settings within CosmosFullTextPolicy
CosmosFullTextPolicy	Full Text Search Policy
CosmosItemIdentity	Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItem
CosmosItemRequestOptions	Encapsulates options that can be specified for a request issued to cosmos Item.
CosmosItemResponse<T>	The type Cosmos item response.
CosmosMetricCategory	Categories for Cosmos DB client-side metrics
CosmosMetricName	Names of Cosmos DB client-side meters
CosmosMetricTagName	The tag names that can be used for Cosmos client-side meters.
CosmosMicrometerMeterOptions	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.
CosmosMicrometerMetricsOptions	Micrometer-specific Azure Cosmos DB SDK metrics options
CosmosOperationDetails	Encapsulates the details of an operation and allows for overriding some properties in the internal request options.
CosmosPatchItemRequestOptions	Encapsulates options for CosmosPatchOperations
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.
CosmosPermissionProperties	The type Cosmos permission properties.
CosmosPermissionRequestOptions	Contains the request options of CosmosAsyncPermission
CosmosPermissionResponse	The type Cosmos permission response.
CosmosQueryRequestOptions	Specifies the options associated with query methods (enumeration operations) in the Azure Cosmos DB database service.
CosmosReadManyRequestOptions	Specifies the options associated with read many operation in the Azure Cosmos DB database service.
CosmosRequestOptions	The common request options for operations.
CosmosResponse<T>	The cosmos response
CosmosStoredProcedureProperties	Represents a stored procedure in the Azure Cosmos DB database service.
CosmosStoredProcedureRequestOptions	Encapsulates options that can be specified for a request issued to cosmos stored procedure.
CosmosStoredProcedureResponse	The type Cosmos stored procedure response.
CosmosTriggerProperties	The type Cosmos trigger properties.
CosmosTriggerResponse	The type Cosmos trigger response.
CosmosUserDefinedFunctionProperties	The type Cosmos user defined function properties.
CosmosUserDefinedFunctionResponse	The type Cosmos user defined function response.
CosmosUserProperties	The Cosmos user properties.
CosmosUserResponse	The type Cosmos user response.
CosmosVectorEmbedding	Embedding settings within CosmosVectorEmbeddingPolicy
CosmosVectorEmbeddingPolicy	Vector Embedding Policy
CosmosVectorIndexSpec	Vector Indexes spec for Azure CosmosDB service.
DedicatedGatewayRequestOptions	Dedicated Gateway Request Options
EncryptionKeyWrapMetadata	Metadata that can be used to wrap/unwrap a Data Encryption Key using a Customer Managed Key.
ExcludedPath	Represents an excluded path of the IndexingPolicy in the Azure Cosmos DB database service.
FeedResponse<T>	The type Feed response.
IncludedPath	Represents an included path of the IndexingPolicy in the Azure Cosmos DB database service.
IndexingPolicy	Represents the indexing policy configuration for a container in the Azure Cosmos DB database service.
ModelBridgeInternal	DO NOT USE.
PartitionKey	Represents a partition key value in the Azure Cosmos DB database service.
PartitionKeyBuilder	Builder for partition keys.
PartitionKeyDefinition	Represents a partition key definition in the Azure Cosmos DB database service.
PriorityLevel	Enumeration specifying Priority Level of requests
SpatialSpec	The type Spatial spec.
SqlParameter	Represents a SQL parameter in the SqlQuerySpec used for queries in the Azure Cosmos DB database service.
SqlQuerySpec	Represents a SQL query in the Azure Cosmos DB database service.
ThroughputProperties	Represents throughput of the resources in the Azure Cosmos DB service.
ThroughputResponse	The cosmos throughput response.
UniqueKey	Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos DB service.
UniqueKeyPolicy	Represents the unique key policy configuration for specifying uniqueness constraints on items in the container in the Azure Cosmos DB service.

Interfaces

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.
CosmosItemOperation	Encapsulates Cosmos Item Operation
FeedRange	Represents a feed range.

Enums

ChangeFeedOperationType	Change feed operation type
CompositePathSortOrder	Represents the sorting order for a path in a composite index, for a container in the Azure Cosmos DB database service.
ConflictResolutionMode	The enum Conflict resolution mode.
ContainerChildResourceType	Specifies the kind of resource that has a Cosmos container as parent resource.
CosmosItemOperationType	Depicts type of Cosmos Item Operation
CosmosVectorDataType	Data types for the embeddings in Cosmos DB database service.
CosmosVectorDistanceFunction	Distance Function for the embeddings in the Cosmos DB database service.
CosmosVectorIndexType	Defines the index type of vector index specification in the Azure Cosmos DB 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.
PartitionKeyDefinitionVersion	Partitioning version.
PartitionKind	Specifies the partition scheme for a multiple-partitioned container in the Azure Cosmos DB database service.
PermissionMode	Enumeration specifying applicability of permission in the Azure Cosmos DB database service.
ShowQueryMode	Defines whether to print db.statement in tracing.
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.