Uses of Class
com.azure.cosmos.models.PartitionKey

Packages that use PartitionKey

Package	Description
com.azure.cosmos	This package provides interfaces for interacting with Azure Cosmos DB.
com.azure.cosmos.models	This package provides rest contracts for interacting with Azure Cosmos DB SQL APIs.

Uses of PartitionKey in com.azure.cosmos

Methods in com.azure.cosmos that return PartitionKey

Modifier and Type	Method and Description
PartitionKey	CosmosItemOperation.getPartitionKeyValue()
PartitionKey	TransactionalBatch.getPartitionKeyValue() Return the partition key for this batch.

Methods in com.azure.cosmos with parameters of type PartitionKey

Modifier and Type	Method and Description
<T> CosmosItemResponse<T>	CosmosContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Creates an item.
static TransactionalBatch	TransactionalBatch.createTransactionalBatch(PartitionKey partitionKey) Initializes a new instance of TransactionalBatch that will contain operations to be performed across multiple items in the container with the provided partition key in a transactional manner
Mono<CosmosItemResponse<Object>>	CosmosAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey) Deletes an item.
CosmosItemResponse<Object>	CosmosContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Deletes an item in the current container.
Mono<CosmosItemResponse<Object>>	CosmosAsyncContainer.deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Deletes the item.
static <T> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey) Instantiate an operation for Creating item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for Creating item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for Creating item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getCreateItemOperation(T item, PartitionKey partitionKey, TContext context) Instantiate an operation for Creating item in Bulk execution.
static CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey) Instantiate an operation for deleting item in Bulk execution.
static CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for deleting item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getDeleteItemOperation(String id, PartitionKey partitionKey, TContext context) Instantiate an operation for deleting item in Bulk execution.
static CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations) Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, BulkPatchItemRequestOptions requestOptions) Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, BulkPatchItemRequestOptions requestOptions, TContext context) Instantiate an operation for a patch in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getPatchItemOperation(String id, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, TContext context) Instantiate an operation for a patch in Bulk execution.
static CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey) Instantiate an operation for read item in Bulk execution.
static CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for read item in Bulk execution.
static <TContext> CosmosItemOperation	BulkOperations.getReadItemOperation(String id, PartitionKey partitionKey, TContext context) Instantiate an operation for read item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey) Instantiate an operation for replace item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for replace item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for replace item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getReplaceItemOperation(String id, T item, PartitionKey partitionKey, TContext context) Instantiate an operation for replace item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey) Instantiate an operation for upsert item in Bulk execution.
static <T> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions) Instantiate an operation for upsert item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, BulkItemRequestOptions requestOptions, TContext context) Instantiate an operation for upsert item in Bulk execution.
static <T,TContext> CosmosItemOperation	BulkOperations.getUpsertItemOperation(T item, PartitionKey partitionKey, TContext context) Instantiate an operation for upsert item in Bulk execution.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType) Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, Class<T> itemType) Run patch operations on an Item.
<T> CosmosItemResponse<T>	CosmosContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
<T> CosmosPagedIterable<T>	CosmosContainer.readAllItems(PartitionKey partitionKey, Class<T> classType) Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> CosmosPagedFlux<T>	CosmosAsyncContainer.readAllItems(PartitionKey partitionKey, Class<T> classType) Reads all the items of a logical partition
<T> CosmosPagedIterable<T>	CosmosContainer.readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType) Reads all the items of a logical partition returning the results as CosmosPagedIterable.
<T> CosmosPagedFlux<T>	CosmosAsyncContainer.readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType) Reads all the items of a logical partition
<T> CosmosItemResponse<T>	CosmosContainer.readItem(String itemId, PartitionKey partitionKey, Class<T> itemType) Reads an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.readItem(String itemId, PartitionKey partitionKey, Class<T> itemType) Reads an item.
<T> CosmosItemResponse<T>	CosmosContainer.readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType) Reads an item in the current container while specifying additional options.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType) Reads an item using a configured CosmosItemRequestOptions.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey) Replaces an item with the passed in item.
<T> CosmosItemResponse<T>	CosmosContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Replaces an item in the current container.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Replaces an item with the passed in item.
<T> CosmosItemResponse<T>	CosmosContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.
<T> Mono<CosmosItemResponse<T>>	CosmosAsyncContainer.upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Upserts an item.

Uses of PartitionKey in com.azure.cosmos.models

Fields in com.azure.cosmos.models declared as PartitionKey

Modifier and Type	Field and Description
static PartitionKey	PartitionKey.NONE

Methods in com.azure.cosmos.models that return PartitionKey

Modifier and Type	Method and Description
PartitionKey	PartitionKeyBuilder.build() Builds a new instance of the type PartitionKey with the specified Partition Key values.
PartitionKey	CosmosStoredProcedureRequestOptions.getPartitionKey() Gets the partition key used to identify the current request's target partition.
PartitionKey	CosmosConflictRequestOptions.getPartitionKey() Gets the partition key associated with the request in the Azure Cosmos DB service.
PartitionKey	CosmosQueryRequestOptions.getPartitionKey() Gets the partition key used to identify the current request's target partition.
PartitionKey	CosmosItemIdentity.getPartitionKey() Gets the partition key
PartitionKey	CosmosPermissionProperties.getResourcePartitionKey() Gets the resource partition key associated with this permission object.

Methods in com.azure.cosmos.models with parameters of type PartitionKey

Modifier and Type	Method and Description
static FeedRange	FeedRange.forLogicalPartition(PartitionKey partitionKey) Creates a range for a certain logical partition
CosmosStoredProcedureRequestOptions	CosmosStoredProcedureRequestOptions.setPartitionKey(PartitionKey partitionKey) Sets the partition key used to identify the current request's target partition.
CosmosConflictRequestOptions	CosmosConflictRequestOptions.setPartitionKey(PartitionKey partitionKey) Sets the partition key associated with the request in the Azure Cosmos DB service.
CosmosQueryRequestOptions	CosmosQueryRequestOptions.setPartitionKey(PartitionKey partitionkey) Sets the partition key used to identify the current request's target partition.
CosmosPermissionProperties	CosmosPermissionProperties.setResourcePartitionKey(PartitionKey partitionKey) Sets the resource partition key associated with this permission object.

Constructors in com.azure.cosmos.models with parameters of type PartitionKey

Constructor and Description
CosmosConflictRequestOptions(PartitionKey partitionKey)
CosmosItemIdentity(PartitionKey partitionKey, String id) Instantiates an instance of the CosmosItemIdentity class