com.azure.cosmos

Class CosmosContainer

java.lang.Object

com.azure.cosmos.CosmosContainer

public class CosmosContainer
extends Object

Provides synchronous methods for reading, deleting, and replacing existing Containers Provides methods for interacting with child resources (Items, Scripts, Conflicts)

Method Summary

Modifier and Type	Method and Description
<T> CosmosItemResponse<T>	createItem(T item) Creates a new item synchronously and returns its respective Cosmos item response.
<T> CosmosItemResponse<T>	createItem(T item, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
<T> CosmosItemResponse<T>	createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Creates a new item synchronously and returns its respective Cosmos item response while specifying additional options.
CosmosContainerResponse	delete() Deletes the current cosmos container.
CosmosContainerResponse	delete(CosmosContainerRequestOptions options) Deletes the current Cosmos container while specifying additional options such as If-Match.
CosmosItemResponse<Object>	deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Deletes an item in the current container.
String	getId() Gets the current container id.
CosmosScripts	getScripts() Gets the Cosmos scripts using the current container as context.
<T> CosmosPagedIterable<T>	queryItems(SqlQuerySpec querySpec, CosmosQueryRequestOptions options, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable.
<T> CosmosPagedIterable<T>	queryItems(String query, CosmosQueryRequestOptions options, Class<T> classType) Query items in the current container returning the results as CosmosPagedIterable.
CosmosContainerResponse	read() Reads the current container.
CosmosContainerResponse	read(CosmosContainerRequestOptions options) Reads the current container while specifying additional options such as If-Match.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, Class<T> itemType) Reads an item in the current container.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType) Reads an item in the current container while specifying additional options.
ThroughputResponse	readThroughput() Gets the throughput for the current container.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties) Replaces the current container properties.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Replaces the current container properties while specifying additional options such as If-Match.
<T> CosmosItemResponse<T>	replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Replaces an item in the current container.
ThroughputResponse	replaceThroughput(ThroughputProperties throughputProperties) Sets the throughput for the current container.
<T> CosmosItemResponse<T>	upsertItem(T item) Upserts an Cosmos item in the current container.
<T> CosmosItemResponse<T>	upsertItem(T item, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.
<T> CosmosItemResponse<T>	upsertItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Upserts a item Cosmos sync item while specifying additional options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getId

public String getId()

Gets the current container id.

Returns:

the container id.

read

public CosmosContainerResponse read()

Reads the current container.

Returns:

the Cosmos container response with the read container.

read

public CosmosContainerResponse read(CosmosContainerRequestOptions options)

Reads the current container while specifying additional options such as If-Match.

Parameters:

options - the options.

Returns:

the Cosmos container response.

delete

public CosmosContainerResponse delete(CosmosContainerRequestOptions options)

Deletes the current Cosmos container while specifying additional options such as If-Match.

Parameters:

options - the options.

Returns:

the cosmos container response.

delete

public CosmosContainerResponse delete()

Deletes the current cosmos container.

Returns:

the cosmos container response.

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties)

Replaces the current container properties.

Parameters:

containerProperties - the container properties.

Returns:

the cosmos container response.

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties,
                                       CosmosContainerRequestOptions options)

Replaces the current container properties while specifying additional options such as If-Match.

Parameters:

containerProperties - the container properties.

options - the options.

Returns:

the cosmos container response.

replaceThroughput

public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)

Sets the throughput for the current container.

Parameters:

throughputProperties - the throughput properties.

Returns:

the throughput response.

readThroughput

public ThroughputResponse readThroughput()

Gets the throughput for the current container.

Returns:

the throughput response.

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,
                                            PartitionKey partitionKey,
                                            CosmosItemRequestOptions options)

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.

options - the options.

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.

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 options)

Upserts a item Cosmos sync item while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

item - the item.

partitionKey - the partitionKey.

options - the options.

Returns:

the Cosmos item response.

queryItems

public <T> CosmosPagedIterable<T> queryItems(String query,
                                             CosmosQueryRequestOptions options,
                                             Class<T> classType)

Query items in the current container returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

query - the query.

options - the options.

classType - the class type.

Returns:

the CosmosPagedIterable.

queryItems

public <T> CosmosPagedIterable<T> queryItems(SqlQuerySpec querySpec,
                                             CosmosQueryRequestOptions options,
                                             Class<T> classType)

Query items in the current container returning the results as CosmosPagedIterable.

Type Parameters:

T - the type parameter.

Parameters:

querySpec - the query spec.

options - the options.

classType - the class type.

Returns:

the CosmosPagedIterable.

readItem

public <T> CosmosItemResponse<T> readItem(String itemId,
                                          PartitionKey partitionKey,
                                          Class<T> itemType)

Reads an item in the current container.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

itemType - the class type of item.

Returns:

the Cosmos item response.

readItem

public <T> CosmosItemResponse<T> readItem(String itemId,
                                          PartitionKey partitionKey,
                                          CosmosItemRequestOptions options,
                                          Class<T> itemType)

Reads an item in the current container while specifying additional options.

Type Parameters:

T - the type parameter.

Parameters:

itemId - the item id.

partitionKey - the partition key.

options - the options.

itemType - the class type of item.

Returns:

the Cosmos item response.

replaceItem

public <T> CosmosItemResponse<T> replaceItem(T item,
                                             String itemId,
                                             PartitionKey partitionKey,
                                             CosmosItemRequestOptions options)

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.

options - the options.

Returns:

the Cosmos item response.

deleteItem

public CosmosItemResponse<Object> deleteItem(String itemId,
                                             PartitionKey partitionKey,
                                             CosmosItemRequestOptions options)

Deletes an item in the current container.

Parameters:

itemId - the item id.

partitionKey - the partition key.

options - the options.

Returns:

the Cosmos item response.

getScripts

public CosmosScripts getScripts()

Gets the Cosmos scripts using the current container as context.

Returns:

the Cosmos sync scripts.