CosmosAsyncContainer (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.cosmos.CosmosAsyncContainer

```
public class CosmosAsyncContainer
extends Object
```
Provides methods for reading, deleting, and replacing existing Containers. Provides methods for interacting with child resources (Items, Scripts, Conflicts)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> Mono<CosmosItemResponse<T>>`	`createItem(T item)` Creates an item.
`<T> Mono<CosmosItemResponse<T>>`	`createItem(T item, CosmosItemRequestOptions options)` Creates a Cosmos item.
`<T> Mono<CosmosItemResponse<T>>`	`createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)` Creates an item.
`Mono<CosmosContainerResponse>`	`delete()` Deletes the current container.
`Mono<CosmosContainerResponse>`	`delete(CosmosContainerRequestOptions options)` Deletes the container
`Mono<CosmosItemResponse<Object>>`	`deleteItem(String itemId, PartitionKey partitionKey)` Deletes an item.
`Mono<CosmosItemResponse<Object>>`	`deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)` Deletes the item.
`<T> Mono<CosmosItemResponse<Object>>`	`deleteItem(T item, CosmosItemRequestOptions options)` Deletes the item.
`CosmosAsyncConflict`	`getConflict(String id)` Gets a `CosmosAsyncConflict` object using current container for context.
`CosmosAsyncDatabase`	`getDatabase()` Gets the parent `CosmosAsyncDatabase` for the current container.
`String`	`getId()` Get the id of the `CosmosAsyncContainer`.
`CosmosAsyncScripts`	`getScripts()` Gets a `CosmosAsyncScripts` using the current container as context.
`CosmosPagedFlux<CosmosConflictProperties>`	`queryConflicts(String query)` Queries all the conflicts in the current container.
`CosmosPagedFlux<CosmosConflictProperties>`	`queryConflicts(String query, CosmosQueryRequestOptions options)` Queries all the conflicts in the current container.
`<T> CosmosPagedFlux<T>`	`queryItems(SqlQuerySpec querySpec, Class<T> classType)` Query for items in the current container using a `SqlQuerySpec`.
`<T> CosmosPagedFlux<T>`	`queryItems(SqlQuerySpec querySpec, CosmosQueryRequestOptions options, 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 options, Class<T> classType)` Query for items in the current container using a string.
`Mono<CosmosContainerResponse>`	`read()` Reads the current container.
`Mono<CosmosContainerResponse>`	`read(CosmosContainerRequestOptions options)` Reads the current container while specifying additional options such as If-Match.
`CosmosPagedFlux<CosmosConflictProperties>`	`readAllConflicts(CosmosQueryRequestOptions options)` Lists all the conflicts in the current container.
`<T> CosmosPagedFlux<T>`	`readAllItems(PartitionKey partitionKey, Class<T> classType)` Reads all the items of a logical partition
`<T> CosmosPagedFlux<T>`	`readAllItems(PartitionKey partitionKey, CosmosQueryRequestOptions options, Class<T> classType)` Reads all the items of a logical partition
`<T> Mono<CosmosItemResponse<T>>`	`readItem(String itemId, PartitionKey partitionKey, Class<T> itemType)` Reads an item.
`<T> Mono<CosmosItemResponse<T>>`	`readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType)` Reads an item using a configured `CosmosItemRequestOptions`.
`<T> Mono<FeedResponse<T>>`	`readMany(List<CosmosItemIdentity> itemIdentityList, Class<T> classType)` Reads many documents.
`<T> Mono<FeedResponse<T>>`	`readMany(List<CosmosItemIdentity> itemIdentityList, String sessionToken, Class<T> classType)` Reads many documents.
`Mono<ThroughputResponse>`	`readThroughput()` Read the throughput provisioned for the current container.
`Mono<CosmosContainerResponse>`	`replace(CosmosContainerProperties containerProperties)` Replaces the current container's properties.
`Mono<CosmosContainerResponse>`	`replace(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)` Replaces the current container properties while using non-default request options.
`<T> Mono<CosmosItemResponse<T>>`	`replaceItem(T item, String itemId, PartitionKey partitionKey)` Replaces an item with the passed in item.
`<T> Mono<CosmosItemResponse<T>>`	`replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)` Replaces an item with the passed in item.
`Mono<ThroughputResponse>`	`replaceThroughput(ThroughputProperties throughputProperties)` Replace the throughput.
`<T> Mono<CosmosItemResponse<T>>`	`upsertItem(T item)` Upserts an item.
`<T> Mono<CosmosItemResponse<T>>`	`upsertItem(T item, CosmosItemRequestOptions options)` Upserts an item.
`<T> Mono<CosmosItemResponse<T>>`	`upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)` Upserts an item.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getId
```
public String getId()
```
    Get the id of the CosmosAsyncContainer.
    
    Returns:
    
    the id of the CosmosAsyncContainer.
  - read
```
public Mono<CosmosContainerResponse> read()
```
    Reads the current container.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response with the read container. In case of failure the Mono will error.
    
    Returns:
    
    an Mono containing the single Cosmos container response with the read container or an error.
  - read
```
public Mono<CosmosContainerResponse> read(CosmosContainerRequestOptions options)
```
    Reads the current container while specifying additional options such as If-Match.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response with the read container. In case of failure the Mono will error.
    
    Parameters:
    
    options - the Cosmos container request options.
    
    Returns:
    
    an Mono containing the single Cosmos container response with the read container or an error.
  - delete
```
public Mono<CosmosContainerResponse> delete(CosmosContainerRequestOptions options)
```
    Deletes the container
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response for the deleted database. In case of failure the Mono will error.
    
    Parameters:
    
    options - the request options.
    
    Returns:
    
    an Mono containing the single Cosmos container response for the deleted database or an error.
  - delete
```
public Mono<CosmosContainerResponse> delete()
```
    Deletes the current container.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response for the deleted container. In case of failure the Mono will error.
    
    Returns:
    
    an Mono containing the single Cosmos container response for the deleted container or an error.
  - replace
```
public Mono<CosmosContainerResponse> replace(CosmosContainerProperties containerProperties)
```
    Replaces the current container's properties.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response with the replaced container properties. In case of failure the Mono will error.
    
    Parameters:
    
    containerProperties - the container properties
    
    Returns:
    
    an Mono containing the single Cosmos container response with the replaced container properties or an error.
  - replace
```
public Mono<CosmosContainerResponse> replace(CosmosContainerProperties containerProperties,
                                             CosmosContainerRequestOptions options)
```
    Replaces the current container properties while using non-default request options.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos container response with the replaced container properties. In case of failure the Mono will error.
    
    Parameters:
    
    containerProperties - the container properties
    
    options - the Cosmos container request options.
    
    Returns:
    
    an Mono containing the single Cosmos container response with the replaced container properties or an error.
  - createItem
```
public <T> Mono<CosmosItemResponse<T>> createItem(T item)
```
    Creates an 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the Cosmos item represented as a POJO or Cosmos item object.
    
    Returns:
    
    an Mono containing the single resource response with the created Cosmos item or an error.
  - createItem
```
public <T> Mono<CosmosItemResponse<T>> createItem(T item,
                                                  PartitionKey partitionKey,
                                                  CosmosItemRequestOptions options)
```
    Creates an 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the Cosmos item represented as a POJO or Cosmos item object.
    
    partitionKey - the partition key.
    
    options - the request options.
    
    Returns:
    
    an Mono containing the single resource response with the created Cosmos item or an error.
  - createItem
```
public <T> Mono<CosmosItemResponse<T>> createItem(T item,
                                                  CosmosItemRequestOptions options)
```
    Creates a Cosmos item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item.
    
    options - the item request options.
    
    Returns:
    
    an Mono containing the single resource response with the created Cosmos item or an error.
  - upsertItem
```
public <T> Mono<CosmosItemResponse<T>> upsertItem(T item)
```
    Upserts an 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item represented as a POJO or Item object to upsert.
    
    Returns:
    
    an Mono containing the single resource response with the upserted item or an error.
  - upsertItem
```
public <T> Mono<CosmosItemResponse<T>> upsertItem(T item,
                                                  CosmosItemRequestOptions options)
```
    Upserts an 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item represented as a POJO or Item object to upsert.
    
    options - the request options.
    
    Returns:
    
    an Mono containing the single resource response with the upserted item or an error.
  - upsertItem
```
public <T> Mono<CosmosItemResponse<T>> upsertItem(T item,
                                                  PartitionKey partitionKey,
                                                  CosmosItemRequestOptions options)
```
    Upserts an 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item represented as a POJO or Item object to upsert.
    
    partitionKey - the partition key.
    
    options - the request options.
    
    Returns:
    
    an Mono containing the single resource response with the upserted item or an error.
  - queryItems
```
public <T> CosmosPagedFlux<T> queryItems(String query,
                                         Class<T> classType)
```
    Query for items in the current container.
    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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    query - the query.
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosPagedFlux<T> queryItems(String query,
                                         CosmosQueryRequestOptions options,
                                         Class<T> classType)
```
    Query for items in the current container using a string.
    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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    query - the query.
    
    options - the query request options.
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosPagedFlux<T> queryItems(SqlQuerySpec querySpec,
                                         Class<T> classType)
```
    Query for items in the current container using a 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    querySpec - the SQL query specification.
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosPagedFlux<T> queryItems(SqlQuerySpec querySpec,
                                         CosmosQueryRequestOptions options,
                                         Class<T> classType)
```
    Query for items in the current container using a 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.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    querySpec - the SQL query specification.
    
    options - the query request options.
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained items or an error.
  - readItem
```
public <T> Mono<CosmosItemResponse<T>> readItem(String itemId,
                                                PartitionKey partitionKey,
                                                Class<T> itemType)
```
    Reads an item.
    After subscription the operation will be performed. The Mono upon successful completion will contain an item response with the read item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    itemId - the item id.
    
    partitionKey - the partition key.
    
    itemType - the item type.
    
    Returns:
    
    an Mono containing the Cosmos item response with the read item or an error.
  - readItem
```
public <T> Mono<CosmosItemResponse<T>> readItem(String itemId,
                                                PartitionKey partitionKey,
                                                CosmosItemRequestOptions options,
                                                Class<T> itemType)
```
    Reads an item using a configured CosmosItemRequestOptions.
    After subscription the operation will be performed. The Mono upon successful completion will contain a Cosmos item response with the read item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    itemId - the item id.
    
    partitionKey - the partition key.
    
    options - the request CosmosItemRequestOptions.
    
    itemType - the item type.
    
    Returns:
    
    an Mono containing the Cosmos item response with the read item or an error.
  - readMany
```
@Beta(value=V4_4_0)
public <T> Mono<FeedResponse<T>> readMany(List<CosmosItemIdentity> itemIdentityList,
                                                              Class<T> classType)
```
    Reads many documents.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    itemIdentityList - CosmosItem id and partition key tuple of items that that needs to be read
    
    classType - class type
    
    Returns:
    
    a Mono with feed response of cosmos items
  - readMany
```
@Beta(value=V4_4_0)
public <T> Mono<FeedResponse<T>> readMany(List<CosmosItemIdentity> itemIdentityList,
                                                              String sessionToken,
                                                              Class<T> classType)
```
    Reads many documents.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    itemIdentityList - CosmosItem id and partition key tuple of items that that needs to be read
    
    sessionToken - the optional Session token - null if the read can be made without specific session token
    
    classType - class type
    
    Returns:
    
    a Mono with feed response of cosmos items
  - readAllItems
```
public <T> CosmosPagedFlux<T> readAllItems(PartitionKey partitionKey,
                                           Class<T> classType)
```
    Reads all the items of a logical partition
    After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed responses of the read Cosmos items. In case of failure the CosmosPagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    partitionKey - the partition key value of the documents that need to be read
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the read Cosmos items or an error.
  - readAllItems
```
public <T> CosmosPagedFlux<T> readAllItems(PartitionKey partitionKey,
                                           CosmosQueryRequestOptions options,
                                           Class<T> classType)
```
    Reads all the items of a logical partition
    After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed responses of the read Cosmos items. In case of failure the CosmosPagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    partitionKey - the partition key value of the documents that need to be read
    
    options - the feed options.
    
    classType - the class type.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the read Cosmos items or an error.
  - replaceItem
```
public <T> Mono<CosmosItemResponse<T>> replaceItem(T item,
                                                   String itemId,
                                                   PartitionKey partitionKey)
```
    Replaces an item with the passed in item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos item response with the replaced item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item to replace (containing the item id).
    
    itemId - the item id.
    
    partitionKey - the partition key.
    
    Returns:
    
    an Mono containing the Cosmos item resource response with the replaced item or an error.
  - replaceItem
```
public <T> Mono<CosmosItemResponse<T>> replaceItem(T item,
                                                   String itemId,
                                                   PartitionKey partitionKey,
                                                   CosmosItemRequestOptions options)
```
    Replaces an item with the passed in item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos item response with the replaced item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - the item to replace (containing the item id).
    
    itemId - the item id.
    
    partitionKey - the partition key.
    
    options - the request comosItemRequestOptions.
    
    Returns:
    
    an Mono containing the Cosmos item resource response with the replaced item or an error.
  - deleteItem
```
public Mono<CosmosItemResponse<Object>> deleteItem(String itemId,
                                                   PartitionKey partitionKey)
```
    Deletes an item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos item response for the deleted item.
    
    Parameters:
    
    itemId - the item id.
    
    partitionKey - the partition key.
    
    Returns:
    
    an Mono containing the Cosmos item resource response.
  - deleteItem
```
public Mono<CosmosItemResponse<Object>> deleteItem(String itemId,
                                                   PartitionKey partitionKey,
                                                   CosmosItemRequestOptions options)
```
    Deletes the item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos item response for the deleted item.
    
    Parameters:
    
    itemId - id of the item.
    
    partitionKey - partitionKey of the item.
    
    options - the request options.
    
    Returns:
    
    an Mono containing the Cosmos item resource response.
  - deleteItem
```
public <T> Mono<CosmosItemResponse<Object>> deleteItem(T item,
                                                       CosmosItemRequestOptions options)
```
    Deletes the item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single Cosmos item response for the deleted item.
    
    Type Parameters:
    
    T - the type parameter.
    
    Parameters:
    
    item - item to be deleted.
    
    options - the request options.
    
    Returns:
    
    an Mono containing the Cosmos item resource response.
  - getScripts
```
public CosmosAsyncScripts getScripts()
```
    Gets a CosmosAsyncScripts using the current container as context.
    This can be further used to perform various operations on Cosmos scripts.
    
    Returns:
    
    the CosmosAsyncScripts.
  - readAllConflicts
```
public CosmosPagedFlux<CosmosConflictProperties> readAllConflicts(CosmosQueryRequestOptions options)
```
    Lists all the conflicts in the current container.
    
    Parameters:
    
    options - the query request options
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - queryConflicts
```
public CosmosPagedFlux<CosmosConflictProperties> queryConflicts(String query)
```
    Queries all the conflicts in the current container.
    
    Parameters:
    
    query - the query.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - queryConflicts
```
public CosmosPagedFlux<CosmosConflictProperties> queryConflicts(String query,
                                                                CosmosQueryRequestOptions options)
```
    Queries all the conflicts in the current container.
    
    Parameters:
    
    query - the query.
    
    options - the query request options.
    
    Returns:
    
    a CosmosPagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - getConflict
```
public CosmosAsyncConflict getConflict(String id)
```
    Gets a CosmosAsyncConflict object using current container for context.
    
    Parameters:
    
    id - the id of the Cosmos conflict.
    
    Returns:
    
    a Cosmos conflict.
  - replaceThroughput
```
public Mono<ThroughputResponse> replaceThroughput(ThroughputProperties throughputProperties)
```
    Replace the throughput.
    
    Parameters:
    
    throughputProperties - the throughput properties.
    
    Returns:
    
    the mono containing throughput response.
  - readThroughput
```
public Mono<ThroughputResponse> readThroughput()
```
    Read the throughput provisioned for the current container.
    
    Returns:
    
    the mono containing throughput response.
  - getDatabase
```
public CosmosAsyncDatabase getDatabase()
```
    Gets the parent CosmosAsyncDatabase for the current container.
    
    Returns:
    
    the CosmosAsyncDatabase.

Class CosmosAsyncContainer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

read

read

delete

delete

replace

replace

createItem

createItem

createItem

upsertItem

upsertItem

upsertItem

queryItems

queryItems

queryItems

queryItems

readItem

readItem

readMany

readMany

readAllItems

readAllItems

replaceItem

replaceItem

deleteItem

deleteItem

deleteItem

getScripts

readAllConflicts

queryConflicts

queryConflicts

getConflict

replaceThroughput

readThroughput

getDatabase