com.azure.cosmos

Class CosmosContainerProperties

java.lang.Object

com.azure.cosmos.JsonSerializable

com.azure.cosmos.Resource

com.azure.cosmos.CosmosContainerProperties

public class CosmosContainerProperties
extends Resource

Represents a item container in the Azure Cosmos DB database service. A cosmos container is a named logical container for cosmos items.

A database may contain zero or more named containers and each container consists of zero or more JSON items. Being schema-free, the items in a container do not need to share the same structure or fields. Since containers are application resources, they can be authorized using either the master key or resource keys.

Constructor Summary

Constructors

Constructor and Description
CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition) Constructor
CosmosContainerProperties(String id, String partitionKeyPath) Constructor

Method Summary

Modifier and Type	Method and Description
ConflictResolutionPolicy	getConflictResolutionPolicy() Gets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service.
Integer	getDefaultTimeToLiveInSeconds() Gets the collection's default time-to-live value.
IndexingPolicy	getIndexingPolicy() Gets the container's indexing policy.
PartitionKeyDefinition	getPartitionKeyDefinition() Gets the containers's partition key definition.
UniqueKeyPolicy	getUniqueKeyPolicy() Gets the containers unique key policy
CosmosContainerProperties	setConflictResolutionPolicy(ConflictResolutionPolicy value) Sets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service.
void	setDefaultTimeToLiveInSeconds(Integer timeToLive) Sets the collection's default time-to-live value.
CosmosContainerProperties	setIndexingPolicy(IndexingPolicy indexingPolicy) Sets the container's indexing policy
CosmosContainerProperties	setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) Sets the containers's partition key definition.
CosmosContainerProperties	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Sets the Containers unique key policy

Methods inherited from class com.azure.cosmos.Resource

getETag, getId, getResourceId, getSelfLink, getTimestamp, setId, setResourceId

Methods inherited from class com.azure.cosmos.JsonSerializable

get, getBoolean, getCollection, getDouble, getInt, getList, getLogger, getLong, getMap, getObject, getObjectByPath, getString, has, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosContainerProperties

public CosmosContainerProperties(String id,
                                 String partitionKeyPath)

Constructor

Parameters:

id - id of the Container

partitionKeyPath - partition key path

CosmosContainerProperties

public CosmosContainerProperties(String id,
                                 PartitionKeyDefinition partitionKeyDefinition)

Constructor

Parameters:

id - id of the container

partitionKeyDefinition - the PartitionKeyDefinition

Method Detail

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Gets the container's indexing policy.

Returns:

the indexing policy.

setIndexingPolicy

public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy)

Sets the container's indexing policy

Parameters:

indexingPolicy - IndexingPolicy the indexing policy

Returns:

the CosmosContainerProperties.

Throws:

IllegalArgumentException - the cosmos client exception

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Gets the containers unique key policy

Returns:

the unique key policy

setUniqueKeyPolicy

public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Sets the Containers unique key policy

Parameters:

uniqueKeyPolicy - the unique key policy

Returns:

the CosmosContainerProperties.

Throws:

IllegalArgumentException - the cosmos client exception

getPartitionKeyDefinition

public PartitionKeyDefinition getPartitionKeyDefinition()

Gets the containers's partition key definition.

Returns:

the partition key definition.

setPartitionKeyDefinition

public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

Sets the containers's partition key definition.

Parameters:

partitionKeyDefinition - the partition key definition.

Returns:

the CosmosContainerProperties.

Throws:

IllegalArgumentException - the cosmos client exception

getConflictResolutionPolicy

public ConflictResolutionPolicy getConflictResolutionPolicy()

Gets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service.

Returns:

ConflictResolutionPolicy

setConflictResolutionPolicy

public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value)

Sets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service.

Parameters:

value - ConflictResolutionPolicy to be used.

Returns:

the CosmosContainerProperties.

Throws:

IllegalArgumentException - the cosmos client exception

getDefaultTimeToLiveInSeconds

public Integer getDefaultTimeToLiveInSeconds()

Gets the collection's default time-to-live value.

Returns:

the default time-to-live value in seconds.

setDefaultTimeToLiveInSeconds

public void setDefaultTimeToLiveInSeconds(Integer timeToLive)

Sets the collection's default time-to-live value.

The default time-to-live value on a collection is an optional property. If set, the documents within the collection expires after the specified number of seconds since their last write time. The value of this property should be one of the following:

null - indicates evaluation of time-to-live is disabled and documents within the collection will never expire, regardless whether individual documents have their time-to-live set.

nonzero positive integer - indicates the default time-to-live value for all documents within the collection. This value can be overridden by individual documents' time-to-live value.

-1 - indicates by default all documents within the collection never expire. This value can be overridden by individual documents' time-to-live value.

Parameters:

timeToLive - the default time-to-live value in seconds.