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) Create item cosmos sync item response.
<T> CosmosItemResponse<T>	createItem(T item, CosmosItemRequestOptions options) Create a cosmos item.
<T> CosmosItemResponse<T>	createItem(T item, PartitionKey partitionKey, CosmosItemRequestOptions options) Create a cosmos item synchronously.
CosmosContainerResponse	delete() Delete cosmos sync container response.
CosmosContainerResponse	delete(CosmosContainerRequestOptions options) Delete cosmos sync container response.
CosmosItemResponse	deleteItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Delete cosmos sync item response.
String	getId() Id string.
CosmosScripts	getScripts() Gets the cosmos sync scripts.
<T> CosmosContinuablePagedIterable<T>	queryItems(SqlQuerySpec querySpec, FeedOptions options, Class<T> klass) Query items CosmosContinuablePagedIterable.
<T> CosmosContinuablePagedIterable<T>	queryItems(String query, FeedOptions options, Class<T> klass) Query items CosmosContinuablePagedIterable.
CosmosContainerResponse	read() Read cosmos sync container response.
CosmosContainerResponse	read(CosmosContainerRequestOptions options) Read cosmos sync container response.
<T> CosmosContinuablePagedIterable<T>	readAllItems(FeedOptions options, Class<T> klass) Read all items CosmosContinuablePagedIterable.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, Class<T> itemType) Read cosmos sync item response.
<T> CosmosItemResponse<T>	readItem(String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options, Class<T> itemType) Read cosmos sync item response.
Integer	readProvisionedThroughput() Read provisioned throughput integer.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties) Replace cosmos sync container response.
CosmosContainerResponse	replace(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Replace cosmos sync container response.
<T> CosmosItemResponse<T>	replaceItem(T item, String itemId, PartitionKey partitionKey, CosmosItemRequestOptions options) Replace cosmos sync item response.
Integer	replaceProvisionedThroughput(int requestUnitsPerSecond) Replace provisioned throughput integer.
<T> CosmosItemResponse<T>	upsertItem(Object item, CosmosItemRequestOptions options) Upsert item cosmos sync item response.
<T> CosmosItemResponse<T>	upsertItem(T item) Upsert item cosmos sync item response.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Id string.

Returns:

the string

read

public CosmosContainerResponse read()
                             throws CosmosClientException

Read cosmos sync container response.

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

read

public CosmosContainerResponse read(CosmosContainerRequestOptions options)
                             throws CosmosClientException

Read cosmos sync container response.

Parameters:

options - the options

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

delete

public CosmosContainerResponse delete(CosmosContainerRequestOptions options)
                               throws CosmosClientException

Delete cosmos sync container response.

Parameters:

options - the options

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

delete

public CosmosContainerResponse delete()
                               throws CosmosClientException

Delete cosmos sync container response.

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties)
                                throws CosmosClientException

Replace cosmos sync container response.

Parameters:

containerProperties - the container properties

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

replace

public CosmosContainerResponse replace(CosmosContainerProperties containerProperties,
                                       CosmosContainerRequestOptions options)
                                throws CosmosClientException

Replace cosmos sync container response.

Parameters:

containerProperties - the container properties

options - the options

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

readProvisionedThroughput

public Integer readProvisionedThroughput()
                                  throws CosmosClientException

Read provisioned throughput integer.

Returns:

the integer. null response indicates database doesn't have any provisioned RUs

Throws:

CosmosClientException - the cosmos client exception

replaceProvisionedThroughput

public Integer replaceProvisionedThroughput(int requestUnitsPerSecond)
                                     throws CosmosClientException

Replace provisioned throughput integer.

Parameters:

requestUnitsPerSecond - the request units per second

Returns:

the integer

Throws:

CosmosClientException - the cosmos client exception

createItem

public <T> CosmosItemResponse<T> createItem(T item)
                                     throws CosmosClientException

Create item cosmos sync item response.

Parameters:

item - the item

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

createItem

public <T> CosmosItemResponse<T> createItem(T item,
                                            PartitionKey partitionKey,
                                            CosmosItemRequestOptions options)
                                     throws CosmosClientException

Create a cosmos item synchronously.

Type Parameters:

T - the type parameter

Parameters:

item - the item

partitionKey - the partition key

options - the options

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

createItem

public <T> CosmosItemResponse<T> createItem(T item,
                                            CosmosItemRequestOptions options)
                                     throws CosmosClientException

Create a cosmos item.

Type Parameters:

T - the type parameter

Parameters:

item - the item

options - the options

Returns:

the cosmos item response

Throws:

CosmosClientException - the cosmos client exception

upsertItem

public <T> CosmosItemResponse<T> upsertItem(T item)
                                     throws CosmosClientException

Upsert item cosmos sync item response.

Parameters:

item - the item

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

upsertItem

public <T> CosmosItemResponse<T> upsertItem(Object item,
                                            CosmosItemRequestOptions options)
                                     throws CosmosClientException

Upsert item cosmos sync item response.

Parameters:

item - the item

options - the options

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

readAllItems

public <T> CosmosContinuablePagedIterable<T> readAllItems(FeedOptions options,
                                                          Class<T> klass)

Read all items CosmosContinuablePagedIterable.

Type Parameters:

T - the type parameter

Parameters:

options - the options

klass - the klass

Returns:

the CosmosContinuablePagedIterable

queryItems

public <T> CosmosContinuablePagedIterable<T> queryItems(String query,
                                                        FeedOptions options,
                                                        Class<T> klass)

Query items CosmosContinuablePagedIterable.

Type Parameters:

T - the type parameter

Parameters:

query - the query

options - the options

klass - the class type

Returns:

the CosmosContinuablePagedIterable

queryItems

public <T> CosmosContinuablePagedIterable<T> queryItems(SqlQuerySpec querySpec,
                                                        FeedOptions options,
                                                        Class<T> klass)

Query items CosmosContinuablePagedIterable.

Type Parameters:

T - the type parameter

Parameters:

querySpec - the query spec

options - the options

klass - the class type

Returns:

the CosmosContinuablePagedIterable

readItem

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

Read cosmos sync item response.

Parameters:

itemId - the item id

partitionKey - the partition key

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

readItem

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

Read cosmos sync item response.

Parameters:

options - the options

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

replaceItem

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

Replace cosmos sync item response.

Type Parameters:

T - the type parameter

Parameters:

item - the item

itemId - the item id

partitionKey - the partition key

options - the options

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

deleteItem

public CosmosItemResponse deleteItem(String itemId,
                                     PartitionKey partitionKey,
                                     CosmosItemRequestOptions options)
                              throws CosmosClientException

Delete cosmos sync item response.

Parameters:

options - the options

Returns:

the cosmos sync item response

Throws:

CosmosClientException - the cosmos client exception

getScripts

public CosmosScripts getScripts()

Gets the cosmos sync scripts.

Returns:

the cosmos sync scripts