Uses of Package
com.azure.cosmos.models
Package
Description
This package provides interfaces for interacting with Azure Cosmos DB.
This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.
This package provides utilities such as
CosmosPagedFlux
and CosmosPagedIterable
for interacting with Azure Cosmos DB SQL APIs.-
ClassDescriptionChange Feed processor item.Specifies the options associated with
ChangeFeedProcessor
.Specifies theChangeFeedProcessor
state for a particular lease/worker.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.Represents a batch of operations against items with the samePartitionKey
in a container that will be performed in a Cosmos manner at the Azure Cosmos DB service.Encapsulates options that can be specified for aCosmosBatch
.Response of aCosmosBatch
request.Encapsulates options that can be specified for operations used in Bulk execution.Request, response and the exception(if any) for aCosmosItemOperation
request when processed using Bulk by callingCosmosAsyncContainer.executeBulkOperations(Flux, CosmosBulkExecutionOptions)
.Encapsulates options that can be specified for an operation within a change feed request.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 telemetryThe type Cosmos conflict properties.The type Cosmos conflict request options.The type Cosmos conflict response.Encapsulates the container link associated with the container.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.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.Encapsulates the PartitionKey/id tuple that uniquely identifies a CosmosItemEncapsulates Cosmos Item OperationEncapsulates options that can be specified for a request issued to cosmos Item.The type Cosmos item response.Encapsulates the details of an operation and allows for overriding some properties in the internal request options.Encapsulates options forCosmosPatchOperations
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 CosmosAsyncPermissionThe 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.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 trigger properties.The type Cosmos trigger response.The type Cosmos user defined function properties.The type Cosmos user defined function response.The Cosmos user properties.The type Cosmos user response.Dedicated Gateway Request OptionsRepresents a feed range.The type Feed response.Represents a partition key value in the Azure Cosmos DB database service.Enumeration specifying Priority Level of requestsRepresents a SQL query in the Azure Cosmos DB database service.Represents throughput of the resources in the Azure Cosmos DB service.The cosmos throughput response. -
ClassDescriptionChange Feed response meta dataChange feed operation typeRepresents the change feed policy configuration for the container in the Azure Cosmos DB service.Specifies the options associated with
ChangeFeedProcessor
.Specifies theChangeFeedProcessor
state for a particular lease/worker.Path that needs encryption and the associated settings withinClientEncryptionPolicy
.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.Specifies the kind of resource that has a Cosmos container as parent resource.Represents a batch of operations against items with the samePartitionKey
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 aCosmosBatch
.Represents a result for a specific operation that was part of aCosmosBatch
request.Encapsulates options that can be specified for an operation within aCosmosBatch
.Encapsulates options that can be specified for aCosmosBatch
.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 aCosmosItemOperation
request when processed using Bulk by callingCosmosAsyncContainer.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.Details of an encryption key for use with the Azure Cosmos DB service.Class with config options for Cosmos Client telemetryThe type Cosmos conflict properties.The type Cosmos conflict request options.Represents a container in the Azure Cosmos DB database service.Encapsulates options that can be specified for a request issued to Cosmos container.Represents a CosmosAsyncDatabase in the Azure Cosmos database service.Encapsulates options that can be specified for a request issued to cosmos database.Encapsulates Cosmos Item OperationDepicts type of Cosmos Item OperationEncapsulates options that can be specified for a request issued to cosmos Item.Categories for Cosmos DB client-side metricsNames of Cosmos DB client-side metersThe 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 optionsEncapsulates options forCosmosPatchOperations
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 CosmosAsyncPermissionSpecifies 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.The common request options for operations.The cosmos responseRepresents 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 trigger properties.The type Cosmos user defined function properties.The Cosmos user properties.Data types for the embeddings in Cosmos DB database service.Distance Function for the embeddings in the Cosmos DB database service.Embedding settings withinCosmosVectorEmbeddingPolicy
Vector Embedding PolicyVector Indexes spec for Azure CosmosDB service.Defines the index type of vector index specification in the Azure Cosmos DB service.Dedicated Gateway Request OptionsMetadata 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.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.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 requestsDefines 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.Represents throughput of the resources in the Azure Cosmos DB service.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. -