Package com.azure.cosmos.encryption

Class CosmosEncryptionContainer

java.lang.Object
com.azure.cosmos.encryption.CosmosEncryptionContainer
public final class CosmosEncryptionContainer extends Object
CosmosContainer with encryption capabilities.

  • Method Details

    • createItem

      public <T> CosmosItemResponse<T> createItem(T item)
      Creates a new item synchronously and returns its respective Cosmos item response.
      Type Parameters:
      T - the type parameter
      Parameters:
      item - the item
      Returns:
      the Cosmos item response

    • createItem

      public <T> CosmosItemResponse<T> 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.

      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      options - the options.
      Returns:
      the cosmos item response.

    • createItem

      public <T> 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.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      partitionKey - the partition key.
      requestOptions - the options.
      Returns:
      the Cosmos item response.

    • deleteItem

      public CosmosItemResponse<Object> deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
      Deletes an item in the current container.
      Parameters:
      itemId - the item id.
      partitionKey - the partition key.
      requestOptions - the options.
      Returns:
      the Cosmos item response.

    • deleteItem

      public <T> CosmosItemResponse<Object> deleteItem(T item, CosmosItemRequestOptions options)
      Deletes an item in the current container.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item to be deleted.
      options - the options.
      Returns:
      the Cosmos item response.

    • upsertItem

      public <T> CosmosItemResponse<T> upsertItem(T item)
      Upserts an Cosmos item in the current container.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      Returns:
      the Cosmos item response.

    • upsertItem

      public <T> CosmosItemResponse<T> upsertItem(T item, CosmosItemRequestOptions options)
      Upserts a item Cosmos sync item while specifying additional options.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      options - the options.
      Returns:
      the Cosmos item response.

    • upsertItem

      public <T> CosmosItemResponse<T> upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
      Upserts a item Cosmos sync item while specifying additional options.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      partitionKey - the partitionKey.
      requestOptions - the options.
      Returns:
      the Cosmos item response.

    • replaceItem

      public <T> CosmosItemResponse<T> replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
      Replaces an item in the current container.
      Type Parameters:
      T - the type parameter.
      Parameters:
      item - the item.
      itemId - the item id.
      partitionKey - the partition key.
      requestOptions - the options.
      Returns:
      the Cosmos item response.

    • readItem

      public <T> CosmosItemResponse<T> readItem(String id, PartitionKey partitionKey, Class<T> classType)
      Reads an item in the current container.
      Type Parameters:
      T - the type parameter.
      Parameters:
      id - the item id.
      partitionKey - the partition key.
      classType - the class type of item.
      Returns:
      the Cosmos item response.

    • readItem

      public <T> CosmosItemResponse<T> readItem(String id, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions, Class<T> classType)
      Reads an item in the current container while specifying additional options.
      Type Parameters:
      T - the type parameter.
      Parameters:
      id - the item id.
      partitionKey - the partition key.
      requestOptions - the options.
      classType - the class type of item.
      Returns:
      the Cosmos item response.

    • queryItems

      public <T> CosmosPagedIterable<T> queryItems(String query, CosmosQueryRequestOptions requestOptions, Class<T> classType)
      Query items in the current container returning the results as CosmosPagedIterable.
      Type Parameters:
      T - the type parameter.
      Parameters:
      query - the query.
      requestOptions - the options.
      classType - the class type.
      Returns:
      the CosmosPagedIterable.

    • queryItems

      public <T> CosmosPagedIterable<T> queryItems(SqlQuerySpec query, CosmosQueryRequestOptions requestOptions, Class<T> classType)
      Query items in the current container returning the results as CosmosPagedIterable.
      Type Parameters:
      T - the type parameter.
      Parameters:
      query - the query spec.
      requestOptions - the options.
      classType - the class type.
      Returns:
      the CosmosPagedIterable.

    • queryItemsOnEncryptedProperties

      public <T> CosmosPagedIterable<T> queryItemsOnEncryptedProperties(SqlQuerySpecWithEncryption sqlQuerySpecWithEncryption, CosmosQueryRequestOptions options, Class<T> classType)
      Query for items in the current container using a SqlQuerySpecWithEncryption.
      Type Parameters:
      T - the type parameter.
      Parameters:
      sqlQuerySpecWithEncryption - the sqlQuerySpecWithEncryption.
      options - the query request options.
      classType - the class type.
      Returns:
      a CosmosPagedIterable.

    • executeCosmosBatch

      public CosmosBatchResponse executeCosmosBatch(CosmosBatch cosmosBatch)
      Executes the encrypted transactional batch.
      Parameters:
      cosmosBatch - Batch having list of operation and partition key which will be executed by this container.
      Returns:
      A CosmosBatchResponse which contains details of execution of the transactional batch.

      If the transactional batch executes successfully, the value returned by CosmosBatchResponse.getStatusCode() on the response returned will be set to 200}.

      If an operation within the transactional batch fails during execution, no changes from the batch will be committed and the status of the failing operation is made available by CosmosBatchResponse.getStatusCode() or by the exception. To obtain information about the operations that failed in case of some user error like conflict, not found etc, the response can be enumerated. This returns CosmosBatchOperationResult instances corresponding to each operation in the transactional batch in the order they were added to the transactional batch. For a result corresponding to an operation within the transactional batch, use CosmosBatchOperationResult.getStatusCode() to access the status of the operation. If the operation was not executed or it was aborted due to the failure of another operation within the transactional batch, the value of this field will be 424; for the operation that caused the batch to abort, the value of this field will indicate the cause of failure.

      If there are issues such as request timeouts, Gone, session not available, network failure or if the service somehow returns 5xx then this will throw an exception instead of returning a CosmosBatchResponse.

      Use CosmosBatchResponse.isSuccessStatusCode() on the response returned to ensure that the transactional batch succeeded.

    • executeCosmosBatch

      public CosmosBatchResponse executeCosmosBatch(CosmosBatch cosmosBatch, CosmosBatchRequestOptions requestOptions)
      Executes the encrypted transactional batch.
      Parameters:
      cosmosBatch - Batch having list of operation and partition key which will be executed by this container.
      requestOptions - Options that apply specifically to batch request.
      Returns:
      A CosmosBatchResponse which contains details of execution of the transactional batch.

      If the transactional batch executes successfully, the value returned by CosmosBatchResponse.getStatusCode() on the response returned will be set to 200}.

      If an operation within the transactional batch fails during execution, no changes from the batch will be committed and the status of the failing operation is made available by CosmosBatchResponse.getStatusCode() or by the exception. To obtain information about the operations that failed in case of some user error like conflict, not found etc, the response can be enumerated. This returns CosmosBatchOperationResult instances corresponding to each operation in the transactional batch in the order they were added to the transactional batch. For a result corresponding to an operation within the transactional batch, use CosmosBatchOperationResult.getStatusCode() to access the status of the operation. If the operation was not executed or it was aborted due to the failure of another operation within the transactional batch, the value of this field will be 424; for the operation that caused the batch to abort, the value of this field will indicate the cause of failure.

      If there are issues such as request timeouts, Gone, session not available, network failure or if the service somehow returns 5xx then this will throw an exception instead of returning a CosmosBatchResponse.

      Use CosmosBatchResponse.isSuccessStatusCode() on the response returned to ensure that the transactional batch succeeded.

    • patchItem

      public <T> CosmosItemResponse<T> patchItem(String itemId, PartitionKey partitionKey, CosmosPatchOperations cosmosPatchOperations, CosmosPatchItemRequestOptions options, Class<T> itemType)
      Run patch operations on an Item.
      Type Parameters:
      T - the type parameter.
      Parameters:
      itemId - the item id.
      partitionKey - the partition key.
      cosmosPatchOperations - Represents a container having list of operations to be sequentially applied to the referred Cosmos item.
      options - the request options.
      itemType - the item type.
      Returns:
      the Cosmos item resource response with the patched item or an exception.

    • executeBulkOperations

      public <TContext> Iterable<CosmosBulkOperationResponse<TContext>> executeBulkOperations(Iterable<CosmosItemOperation> operations)
      Executes list of operations in Bulk.
      Type Parameters:
      TContext - The context for the bulk processing.
      Parameters:
      operations - list of operation which will be executed by this container.
      Returns:
      An Iterable of CosmosBulkOperationResponse which contains operation and it's response or exception.

      To create a operation which can be executed here, use CosmosBulkOperations. For eg. for a upsert operation use CosmosBulkOperations.getUpsertItemOperation(Object, PartitionKey)

      We can get the corresponding operation using CosmosBulkOperationResponse.getOperation() and it's response using CosmosBulkOperationResponse.getResponse(). If the operation was executed successfully, the value returned by CosmosBulkItemResponse.isSuccessStatusCode() will be true. To get actual status use CosmosBulkItemResponse.getStatusCode().

      To check if the operation had any exception, use CosmosBulkOperationResponse.getException() to get the exception.

    • executeBulkOperations

      public <TContext> Iterable<CosmosBulkOperationResponse<TContext>> executeBulkOperations(Iterable<CosmosItemOperation> operations, CosmosBulkExecutionOptions bulkOptions)
      Executes list of operations in Bulk.
      Type Parameters:
      TContext - The context for the bulk processing.
      Parameters:
      operations - list of operation which will be executed by this container.
      bulkOptions - Options that apply for this Bulk request which specifies options regarding execution like concurrency, batching size, interval and context.
      Returns:
      An Iterable of CosmosBulkOperationResponse which contains operation and it's response or exception.

      To create a operation which can be executed here, use CosmosBulkOperations. For eg. for a upsert operation use CosmosBulkOperations.getUpsertItemOperation(Object, PartitionKey)

      We can get the corresponding operation using CosmosBulkOperationResponse.getOperation() and it's response using CosmosBulkOperationResponse.getResponse(). If the operation was executed successfully, the value returned by CosmosBulkItemResponse.isSuccessStatusCode() will be true. To get actual status use CosmosBulkItemResponse.getStatusCode().

      To check if the operation had any exception, use CosmosBulkOperationResponse.getException() to get the exception.

    • getCosmosContainer

      public CosmosContainer getCosmosContainer()
      Gets the CosmosContainer
      Returns:
      cosmos container