public class CosmosEncryptionAsyncContainer extends Object
Modifier and Type | Method and Description |
---|---|
<T> Mono<CosmosItemResponse<T>> |
createItem(T item)
Creates an item.
|
<T> Mono<CosmosItemResponse<T>> |
createItem(T item,
CosmosItemRequestOptions requestOptions)
Creates a Cosmos item.
|
<T> Mono<CosmosItemResponse<T>> |
createItem(T item,
PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions)
Creates an item.
|
Mono<CosmosItemResponse<Object>> |
deleteAllItemsByPartitionKey(PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions)
Deletes all items in the Container with the specified partitionKey value.
|
Mono<CosmosItemResponse<Object>> |
deleteItem(String itemId,
PartitionKey partitionKey)
Deletes an item.
|
Mono<CosmosItemResponse<Object>> |
deleteItem(String itemId,
PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions)
Deletes the item.
|
<T> Mono<CosmosItemResponse<Object>> |
deleteItem(T item,
CosmosItemRequestOptions requestOptions)
Deletes the item.
|
Mono<CosmosBatchResponse> |
executeCosmosBatch(CosmosBatch cosmosBatch)
Executes the encrypted transactional batch.
|
Mono<CosmosBatchResponse> |
executeCosmosBatch(CosmosBatch cosmosBatch,
CosmosBatchRequestOptions requestOptions)
Executes the encrypted transactional batch.
|
CosmosAsyncContainer |
getCosmosAsyncContainer()
Gets the CosmosAsyncContainer
|
<T> CosmosPagedFlux<T> |
queryChangeFeed(CosmosChangeFeedRequestOptions options,
Class<T> classType)
Query for items in the change feed of the current container using the
CosmosChangeFeedRequestOptions . |
<T> CosmosPagedFlux<T> |
queryItems(SqlQuerySpec querySpec,
Class<T> classType)
Query for items in the current container using a
SqlQuerySpec . |
<T> CosmosPagedFlux<T> |
queryItems(SqlQuerySpec query,
CosmosQueryRequestOptions requestOptions,
Class<T> classType)
Query for items in the current container using a
SqlQuerySpec and CosmosQueryRequestOptions . |
<T> CosmosPagedFlux<T> |
queryItems(String query,
Class<T> classType)
Query for items in the current container.
|
<T> CosmosPagedFlux<T> |
queryItems(String query,
CosmosQueryRequestOptions requestOptions,
Class<T> classType)
Query for items in the current container using a string.
|
<T> CosmosPagedFlux<T> |
queryItemsOnEncryptedProperties(SqlQuerySpecWithEncryption sqlQuerySpecWithEncryption,
CosmosQueryRequestOptions options,
Class<T> classType)
Query for items in the current container using a
SqlQuerySpecWithEncryption . |
<T> Mono<CosmosItemResponse<T>> |
readItem(String id,
PartitionKey partitionKey,
Class<T> classType)
Reads an item.
|
<T> Mono<CosmosItemResponse<T>> |
readItem(String id,
PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions,
Class<T> classType)
Reads an item using a configured
CosmosItemRequestOptions . |
<T> Mono<CosmosItemResponse<T>> |
replaceItem(T item,
String itemId,
PartitionKey partitionKey)
Replaces an item with the passed in item and encrypts the requested fields.
|
<T> Mono<CosmosItemResponse<T>> |
replaceItem(T item,
String itemId,
PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions)
Replaces an item with the passed in item and encrypts the requested fields.
|
<T> Mono<CosmosItemResponse<T>> |
upsertItem(T item)
Upserts an item.
|
<T> Mono<CosmosItemResponse<T>> |
upsertItem(T item,
CosmosItemRequestOptions requestOptions)
Upserts an item.
|
<T> Mono<CosmosItemResponse<T>> |
upsertItem(T item,
PartitionKey partitionKey,
CosmosItemRequestOptions requestOptions)
Upserts an item.
|
public <T> Mono<CosmosItemResponse<T>> createItem(T item)
After subscription the operation will be performed. The Mono
upon
successful completion will contain a single resource response with the
created Cosmos item. In case of failure the Mono
will error.
T
- the type parameter.item
- the Cosmos item represented as a POJO or Cosmos item object.Mono
containing the single resource response with the
created Cosmos item or an error.public <T> Mono<CosmosItemResponse<T>> createItem(T item, CosmosItemRequestOptions requestOptions)
T
- the type parameter.item
- the item.requestOptions
- the item request options.Mono
containing the single resource response with the created Cosmos item or an error.public <T> Mono<CosmosItemResponse<T>> createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed. The Mono
upon
successful completion will contain a single resource response with the
created Cosmos item. In case of failure the Mono
will error.
T
- the type parameter.item
- the Cosmos item represented as a POJO or Cosmos item object.partitionKey
- the partition key.requestOptions
- the request options.Mono
containing the single resource response with the created Cosmos item or an error.public Mono<CosmosItemResponse<Object>> deleteItem(String itemId, PartitionKey partitionKey)
After subscription the operation will be performed.
The Mono
upon successful completion will contain a single Cosmos item response for the deleted item.
itemId
- the item id.partitionKey
- the partition key.Mono
containing the Cosmos item resource response.public Mono<CosmosItemResponse<Object>> deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed.
The Mono
upon successful completion will contain a single Cosmos item response for the deleted item.
itemId
- id of the item.partitionKey
- partitionKey of the item.requestOptions
- the request options.Mono
containing the Cosmos item resource response.public <T> Mono<CosmosItemResponse<Object>> deleteItem(T item, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed.
The Mono
upon successful completion will contain a single Cosmos item response for the deleted item.
T
- the type parameter.item
- item to be deleted.requestOptions
- the request options.Mono
containing the Cosmos item resource response.@Beta(value=V1, warningText="Preview API - subject to change in non-backwards compatible way") public Mono<CosmosItemResponse<Object>> deleteAllItemsByPartitionKey(PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
Mono
upon successful completion will contain a single Cosmos item response for all the deleted items.partitionKey
- partitionKey of the item.requestOptions
- the request options.Mono
containing the Cosmos item resource response.public <T> Mono<CosmosItemResponse<T>> upsertItem(T item)
After subscription the operation will be performed. The Mono
upon
successful completion will contain a single resource response with the
upserted item. In case of failure the Mono
will error.
T
- the type parameter.item
- the item represented as a POJO or Item object to upsert.Mono
containing the single resource response with the upserted item or an error.public <T> Mono<CosmosItemResponse<T>> upsertItem(T item, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed. The Mono
upon
successful completion will contain a single resource response with the
upserted item. In case of failure the Mono
will error.
T
- the type parameter.item
- the item represented as a POJO or Item object to upsert.requestOptions
- the request options.Mono
containing the single resource response with the upserted item or an error.public <T> Mono<CosmosItemResponse<T>> upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed. The Mono
upon
successful completion will contain a single resource response with the
upserted item. In case of failure the Mono
will error.
T
- the type parameter.item
- the item represented as a POJO or Item object to upsert.partitionKey
- the partition key.requestOptions
- the request options.Mono
containing the single resource response with the upserted item or an error.public <T> Mono<CosmosItemResponse<T>> replaceItem(T item, String itemId, PartitionKey partitionKey)
After subscription the operation will be performed.
The Mono
upon successful completion will contain a single Cosmos item response with the replaced item.
T
- the type parameter.item
- the item to replace (containing the item id).itemId
- the item id.partitionKey
- the partition key.Mono
containing the Cosmos item resource response with the replaced item or an error.public <T> Mono<CosmosItemResponse<T>> replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions)
After subscription the operation will be performed.
The Mono
upon successful completion will contain a single Cosmos item response with the replaced item.
T
- the type parameter.item
- the item to replace (containing the item id).itemId
- the item id.partitionKey
- the partition key.requestOptions
- the request comosItemRequestOptions.Mono
containing the Cosmos item resource response with the replaced item or an error.public <T> Mono<CosmosItemResponse<T>> readItem(String id, PartitionKey partitionKey, Class<T> classType)
After subscription the operation will be performed.
The Mono
upon successful completion will contain an item response with the read item.
T
- the type parameter.id
- the item id.partitionKey
- the partition key.classType
- the item type.Mono
containing the Cosmos item response with the read item or an error.public <T> Mono<CosmosItemResponse<T>> readItem(String id, PartitionKey partitionKey, CosmosItemRequestOptions requestOptions, Class<T> classType)
CosmosItemRequestOptions
.
After subscription the operation will be performed.
The Mono
upon successful completion will contain a Cosmos item response with the read item.
T
- the type parameter.id
- the item id.partitionKey
- the partition key.requestOptions
- the request CosmosItemRequestOptions
.classType
- the item type.Mono
containing the Cosmos item response with the read item or an error.public <T> CosmosPagedFlux<T> queryItems(String query, Class<T> classType)
After subscription the operation will be performed. The CosmosPagedFlux
will
contain one or several feed response of the obtained items. In case of
failure the CosmosPagedFlux
will error.
T
- the type parameter.query
- the query.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained items or an
error.public <T> CosmosPagedFlux<T> queryItems(String query, CosmosQueryRequestOptions requestOptions, Class<T> classType)
After subscription the operation will be performed. The CosmosPagedFlux
will
contain one or several feed response of the obtained items. In case of
failure the CosmosPagedFlux
will error.
T
- the type parameter.query
- the query.requestOptions
- the query request options.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained items or an
error.public <T> CosmosPagedFlux<T> queryItems(SqlQuerySpec querySpec, Class<T> classType)
SqlQuerySpec
.
After subscription the operation will be performed. The CosmosPagedFlux
will
contain one or several feed response of the obtained items. In case of
failure the CosmosPagedFlux
will error.
T
- the type parameter.querySpec
- the SQL query specification.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained items or an
error.public <T> CosmosPagedFlux<T> queryItems(SqlQuerySpec query, CosmosQueryRequestOptions requestOptions, Class<T> classType)
SqlQuerySpec
and CosmosQueryRequestOptions
.
After subscription the operation will be performed. The Flux
will
contain one or several feed response of the obtained items. In case of
failure the CosmosPagedFlux
will error.
T
- the type parameter.query
- the SQL query specification.requestOptions
- the query request options.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained items or an
error.public <T> CosmosPagedFlux<T> queryItemsOnEncryptedProperties(SqlQuerySpecWithEncryption sqlQuerySpecWithEncryption, CosmosQueryRequestOptions options, Class<T> classType)
SqlQuerySpecWithEncryption
.
After subscription the operation will be performed. The CosmosPagedFlux
will contain one or several feed
response of the obtained items. In case of failure the CosmosPagedFlux
will error.
T
- the type parameter.sqlQuerySpecWithEncryption
- the sqlQuerySpecWithEncryption.options
- the query request options.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained items or an
error.@Beta(value=V1, warningText="Preview API - subject to change in non-backwards compatible way") public <T> CosmosPagedFlux<T> queryChangeFeed(CosmosChangeFeedRequestOptions options, Class<T> classType)
CosmosChangeFeedRequestOptions
.
After subscription the operation will be performed. The Flux
will
contain one or several feed response of the obtained items. In case of
failure the CosmosPagedFlux
will error.
T
- the type parameter.options
- the change feed request options.classType
- the class type.CosmosPagedFlux
containing one or several feed response pages of the obtained
items or an error.public CosmosAsyncContainer getCosmosAsyncContainer()
@Beta(value=V1, warningText="Preview API - subject to change in non-backwards compatible way") public Mono<CosmosBatchResponse> executeCosmosBatch(CosmosBatch cosmosBatch)
cosmosBatch
- Batch having list of operation and partition key which will be executed by this container.
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 the Mono will return error instead of CosmosBatchResponse.
Use CosmosBatchResponse.isSuccessStatusCode()
on the response returned to ensure that the
transactional batch succeeded.
@Beta(value=V1, warningText="Preview API - subject to change in non-backwards compatible way") public Mono<CosmosBatchResponse> executeCosmosBatch(CosmosBatch cosmosBatch, CosmosBatchRequestOptions requestOptions)
cosmosBatch
- Batch having list of operation and partition key which will be executed by this container.requestOptions
- Options that apply specifically to batch request.
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 the Mono will return error instead of CosmosBatchResponse.
Use CosmosBatchResponse.isSuccessStatusCode()
on the response returned to ensure that the
transactional batch succeeded.
Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.