CosmosEncryptionContainer Class

Package:

com.azure.cosmos.encryption

Maven Artifact:

com.azure:azure-cosmos-encryption:2.16.0

• java.lang.Object
• • com.azure.cosmos.encryption.CosmosEncryptionContainer

public final class CosmosEncryptionContainer

CosmosContainer with encryption capabilities.

Method Summary

Modifier and Type	Method and Description
CosmosItemResponse<T>	createItem(T item) Creates a new item synchronously and returns its respective Cosmos item response.
CosmosItemResponse<T>	createItem(T item, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
CosmosItemResponse<T>	createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
CosmosItemResponse<Object>	deleteItem(T item, CosmosItemRequestOptions options) Deletes an item in the current container.
CosmosItemResponse<T>	patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType) Run patch operations on an Item.
CosmosPagedIterable<T>	queryItems(SqlQuerySpec query, CosmosQueryRequestOptions requestOptions, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable<T>.
CosmosPagedIterable<T>	queryItems(String query, CosmosQueryRequestOptions requestOptions, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable<T>.
CosmosPagedIterable<T>	queryItemsOnEncryptedProperties(SqlQuerySpecWithEncryption sqlQuerySpecWithEncryption, CosmosQueryRequestOptions options, Class<T> classType) Query for items in the current container using a SqlQuerySpecWithEncryption.
CosmosItemResponse<T>	readItem(String id, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions, Class<T> classType) Reads an item in the current container while specifying additional options.
CosmosItemResponse<T>	readItem(String id, PartitionKey partitionKey, Class<T> classType) Reads an item in the current container.
CosmosItemResponse<T>	replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions) Replaces an item in the current container.
CosmosItemResponse<T>	upsertItem(T item) Upserts an Cosmos item in the current container.
CosmosItemResponse<T>	upsertItem(T item, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.
CosmosItemResponse<T>	upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions) Upserts a item Cosmos sync item while specifying additional options.
Iterable<CosmosBulkOperationResponse<TContext>>	executeBulkOperations(Iterable<CosmosItemOperation> operations) Executes list of operations in Bulk.
Iterable<CosmosBulkOperationResponse<TContext>>	executeBulkOperations(Iterable<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions) Executes list of operations in Bulk.
CosmosItemResponse<Object>	deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions) Deletes an item in the current container.
CosmosBatchResponse	executeCosmosBatch(CosmosBatch cosmosBatch) Executes the encrypted transactional batch.
CosmosBatchResponse	executeCosmosBatch(CosmosBatch cosmosBatch, CosmosBatchRequestOptions requestOptions) Executes the encrypted transactional batch.
CosmosContainer	getCosmosContainer() Gets the CosmosContainer

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

createItem

public CosmosItemResponse createItem(T item)

Creates a new item synchronously and returns its respective Cosmos item response.

Parameters:

item - the item

Returns:

the Cosmos item response

createItem

public CosmosItemResponse createItem(T item, CosmosItemRequestOptions options)

Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.

The partition key value will be automatically extracted from the item's content.

Parameters:

item - the item.

options - the options.

Returns:

the cosmos item response.

createItem

public CosmosItemResponse createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)

Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.

Parameters:

item - the item.

partitionKey - the partition key.

requestOptions - the options.

Returns:

the Cosmos item response.

deleteItem

public CosmosItemResponse