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> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`createItem(T item)` Creates a cosmos item.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`createItem(T item, CosmosItemRequestOptions options)`
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options)` Creates a cosmos item.
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`delete()` Deletes the item container
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`delete(CosmosContainerRequestOptions options)` Deletes the item container
`reactor.core.publisher.Mono<CosmosAsyncItemResponse>`	`deleteItem(String itemId, PartitionKey partitionKey)` Deletes the item.
`reactor.core.publisher.Mono<CosmosAsyncItemResponse>`	`deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)` Deletes the item.
`CosmosAsyncConflict`	`getConflict(String id)` Gets a CosmosAsyncConflict object without making a service call
`CosmosAsyncDatabase`	`getDatabase()` Gets the parent Database
`String`	`getId()` Get the id of the `CosmosAsyncContainer`
`CosmosAsyncScripts`	`getScripts()`
`CosmosContinuablePagedFlux<CosmosConflictProperties>`	`queryConflicts(String query)` Queries all the conflicts in the container
`CosmosContinuablePagedFlux<CosmosConflictProperties>`	`queryConflicts(String query, FeedOptions options)` Queries all the conflicts in the container
`<T> CosmosContinuablePagedFlux<T>`	`queryItems(SqlQuerySpec querySpec, Class<T> klass)` Query for documents in a items in a container
`<T> CosmosContinuablePagedFlux<T>`	`queryItems(SqlQuerySpec querySpec, FeedOptions options, Class<T> klass)` Query for documents in a items in a container
`<T> CosmosContinuablePagedFlux<T>`	`queryItems(String query, Class<T> klass)` Query for documents in a items in a container
`<T> CosmosContinuablePagedFlux<T>`	`queryItems(String query, FeedOptions options, Class<T> klass)` Query for documents in a items in a container
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`read()` Reads the document container
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`read(CosmosContainerRequestOptions options)` Reads the document container by the container link.
`CosmosContinuablePagedFlux<CosmosConflictProperties>`	`readAllConflicts(FeedOptions options)` Lists all the conflicts in the container
`<T> CosmosContinuablePagedFlux<T>`	`readAllItems(Class<T> klass)` Reads all cosmos items in the container.
`<T> CosmosContinuablePagedFlux<T>`	`readAllItems(FeedOptions options, Class<T> klass)` Reads all cosmos items in a container.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`readItem(String itemId, PartitionKey partitionKey, Class<T> itemType)` Reads an item.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType)` Reads an item.
`reactor.core.publisher.Mono<Integer>`	`readProvisionedThroughput()` Gets the throughput of the container
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`replace(CosmosContainerProperties containerSettings)` Replaces a document container.
`reactor.core.publisher.Mono<CosmosAsyncContainerResponse>`	`replace(CosmosContainerProperties containerSettings, CosmosContainerRequestOptions options)` Replaces a document container.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`replaceItem(T item, String itemId, PartitionKey partitionKey)` Replaces an item with the passed in item.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options)` Replaces an item with the passed in item.
`reactor.core.publisher.Mono<Integer>`	`replaceProvisionedThroughput(int requestUnitsPerSecond)` Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`upsertItem(T item)` Upserts an item.
`<T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>>`	`upsertItem(T item, CosmosItemRequestOptions options)` Upserts a cosmos 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 reactor.core.publisher.Mono<CosmosAsyncContainerResponse> read()
```
    Reads the document 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 reactor.core.publisher.Mono<CosmosAsyncContainerResponse> read(CosmosContainerRequestOptions options)
```
    Reads the document container by the container link.
    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 reactor.core.publisher.Mono<CosmosAsyncContainerResponse> delete(CosmosContainerRequestOptions options)
```
    Deletes the item 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 reactor.core.publisher.Mono<CosmosAsyncContainerResponse> delete()
```
    Deletes the item 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 reactor.core.publisher.Mono<CosmosAsyncContainerResponse> replace(CosmosContainerProperties containerSettings)
```
    Replaces a document container.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos container response with the replaced document container. In case of failure the Mono will error.
    
    Parameters:
    
    containerSettings - the item container properties
    
    Returns:
    
    an Mono containing the single cosmos container response with the replaced document container or an error.
  - replace
```
public reactor.core.publisher.Mono<CosmosAsyncContainerResponse> replace(CosmosContainerProperties containerSettings,
                                                                         CosmosContainerRequestOptions options)
```
    Replaces a document container.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos container response with the replaced document container. In case of failure the Mono will error.
    
    Parameters:
    
    containerSettings - the item container properties
    
    options - the cosmos container request options.
    
    Returns:
    
    an Mono containing the single cosmos container response with the replaced document container or an error.
  - createItem
```
public <T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>> createItem(T item)
```
    Creates a cosmos 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.
    
    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> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>> createItem(T item,
                                                                              PartitionKey partitionKey,
                                                                              CosmosItemRequestOptions options)
```
    Creates a cosmos 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> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>> createItem(T item,
                                                                              CosmosItemRequestOptions options)
```
  - upsertItem
```
public <T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<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.
    
    Parameters:
    
    item - the item represented as a POJO or Item object to upsert.
    
    Returns:
    
    an Mono containing the single resource response with the upserted document or an error.
  - upsertItem
```
public <T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>> upsertItem(T item,
                                                                              CosmosItemRequestOptions options)
```
    Upserts a cosmos 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.
    
    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 document or an error.
  - readAllItems
```
public <T> CosmosContinuablePagedFlux<T> readAllItems(Class<T> klass)
```
    Reads all cosmos items in the container.
    After subscription the operation will be performed. The CosmosContinuablePagedFlux will contain one or several feed response of the read cosmos items. In case of failure the CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the read cosmos items or an error.
  - readAllItems
```
public <T> CosmosContinuablePagedFlux<T> readAllItems(FeedOptions options,
                                                      Class<T> klass)
```
    Reads all cosmos items in a container.
    After subscription the operation will be performed. The CosmosContinuablePagedFlux will contain one or several feed response of the read cosmos items. In case of failure the CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    options - the feed options.
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the read cosmos items or an error.
  - queryItems
```
public <T> CosmosContinuablePagedFlux<T> queryItems(String query,
                                                    Class<T> klass)
```
    Query for documents in a items in a container
    After subscription the operation will be performed. The CosmosContinuablePagedFlux will contain one or several feed response of the obtained items. In case of failure the CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    query - the query.
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosContinuablePagedFlux<T> queryItems(String query,
                                                    FeedOptions options,
                                                    Class<T> klass)
```
    Query for documents in a items in a container
    After subscription the operation will be performed. The CosmosContinuablePagedFlux will contain one or several feed response of the obtained items. In case of failure the CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    query - the query.
    
    options - the feed options.
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosContinuablePagedFlux<T> queryItems(SqlQuerySpec querySpec,
                                                    Class<T> klass)
```
    Query for documents in a items in a container
    After subscription the operation will be performed. The CosmosContinuablePagedFlux will contain one or several feed response of the obtained items. In case of failure the CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    querySpec - the SQL query specification.
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained items or an error.
  - queryItems
```
public <T> CosmosContinuablePagedFlux<T> queryItems(SqlQuerySpec querySpec,
                                                    FeedOptions options,
                                                    Class<T> klass)
```
    Query for documents in a items in a container
    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 CosmosContinuablePagedFlux will error.
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    querySpec - the SQL query specification.
    
    options - the feed options.
    
    klass - the class type
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained items or an error.
  - readItem
```
public <T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<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 a cosmos item response with the read item In case of failure the Mono will error.
    
    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> reactor.core.publisher.Mono<CosmosAsyncItemResponse<T>> readItem(String itemId,
                                                                            PartitionKey partitionKey,
                                                                            CosmosItemRequestOptions options,
                                                                            Class<T> itemType)
```
    Reads an item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos item response with the read item In case of failure the Mono will error.
    
    Parameters:
    
    itemId - the item id
    
    partitionKey - the partition key
    
    options - the request cosmosItemRequestOptions
    
    Returns:
    
    an Mono containing the cosmos item response with the read item or an error
  - replaceItem
```
public <T> reactor.core.publisher.Mono<CosmosAsyncItemResponse<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. In case of failure the Mono will error.
    
    Parameters:
    
    item - the item to replace (containing the document 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> reactor.core.publisher.Mono<CosmosAsyncItemResponse<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. In case of failure the Mono will error.
    
    Parameters:
    
    item - the item to replace (containing the document 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 reactor.core.publisher.Mono<CosmosAsyncItemResponse> deleteItem(String itemId,
                                                                       PartitionKey partitionKey)
```
    Deletes the item.
    After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos item response with the replaced item. In case of failure the Mono will error.
    
    Parameters:
    
    itemId - the item id
    
    partitionKey - the partition key
    
    Returns:
    
    an Mono containing the cosmos item resource response.
  - deleteItem
```
public reactor.core.publisher.Mono<CosmosAsyncItemResponse> 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 with the replaced item. In case of failure the Mono will error.
    
    Parameters:
    
    itemId - id of the item
    
    partitionKey - partitionKey of the item
    
    options - the request options
    
    Returns:
    
    an Mono containing the cosmos item resource response.
  - getScripts
```
public CosmosAsyncScripts getScripts()
```
  - readAllConflicts
```
public CosmosContinuablePagedFlux<CosmosConflictProperties> readAllConflicts(FeedOptions options)
```
    Lists all the conflicts in the container
    
    Parameters:
    
    options - the feed options
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - queryConflicts
```
public CosmosContinuablePagedFlux<CosmosConflictProperties> queryConflicts(String query)
```
    Queries all the conflicts in the container
    
    Parameters:
    
    query - the query
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - queryConflicts
```
public CosmosContinuablePagedFlux<CosmosConflictProperties> queryConflicts(String query,
                                                                           FeedOptions options)
```
    Queries all the conflicts in the container
    
    Parameters:
    
    query - the query
    
    options - the feed options
    
    Returns:
    
    a CosmosContinuablePagedFlux containing one or several feed response pages of the obtained conflicts or an error.
  - getConflict
```
public CosmosAsyncConflict getConflict(String id)
```
    Gets a CosmosAsyncConflict object without making a service call
    
    Parameters:
    
    id - id of the cosmos conflict
    
    Returns:
    
    a cosmos conflict
  - readProvisionedThroughput
```
public reactor.core.publisher.Mono<Integer> readProvisionedThroughput()
```
    Gets the throughput of the container
    
    Returns:
    
    a Mono containing throughput or an error.
  - replaceProvisionedThroughput
```
public reactor.core.publisher.Mono<Integer> replaceProvisionedThroughput(int requestUnitsPerSecond)
```
    Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service.
    
    Parameters:
    
    requestUnitsPerSecond - the cosmos container throughput, expressed in Request Units per second
    
    Returns:
    
    a Mono containing throughput or an error.
  - getDatabase
```
public CosmosAsyncDatabase getDatabase()
```
    Gets the parent Database
    
    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

readAllItems

readAllItems

queryItems

queryItems

queryItems

queryItems

readItem

readItem

replaceItem

replaceItem

deleteItem

deleteItem

getScripts

readAllConflicts

queryConflicts

queryConflicts

getConflict

readProvisionedThroughput

replaceProvisionedThroughput

getDatabase