com.microsoft.azure.cosmos

Class CosmosContainerSettings

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmos.CosmosContainerSettings

public class CosmosContainerSettings
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
CosmosContainerSettings(String id, PartitionKeyDefinition partitionKeyDefinition) Constructor
CosmosContainerSettings(String id, String partitionKeyPath) Constructor

Method Summary

Modifier and Type	Method and Description
IndexingPolicy	getIndexingPolicy() Gets the container's indexing policy.
PartitionKeyDefinition	getPartitionKey() Gets the containers's partition key definition.
UniqueKeyPolicy	getUniqueKeyPolicy() Gets the containers unique key policy
void	setIndexingPolicy(IndexingPolicy indexingPolicy) Sets the container's indexing policy
void	setPartitionKey(PartitionKeyDefinition partitionKeyDefinition) Sets the containers's partition key definition.
void	setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Sets the Containers unique key policy

Methods inherited from class com.microsoft.azure.cosmosdb.Resource

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

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getList, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosContainerSettings

public CosmosContainerSettings(String id,
                               String partitionKeyPath)

Constructor

Parameters:

id - id of the Container

partitionKeyPath - partition key path

CosmosContainerSettings

public CosmosContainerSettings(String id,
                               PartitionKeyDefinition partitionKeyDefinition)

Constructor

Parameters:

id - id of the container

partitionKeyDefinition - the (@link PartitionKeyDefinition)

Method Detail

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Gets the container's indexing policy.

Returns:

the indexing policy.

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

Sets the container's indexing policy

Parameters:

indexingPolicy -

getUniqueKeyPolicy

public UniqueKeyPolicy getUniqueKeyPolicy()

Gets the containers unique key policy

Returns:

the unique key policy

setUniqueKeyPolicy

public void setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Sets the Containers unique key policy

Parameters:

uniqueKeyPolicy - the unique key policy

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

Gets the containers's partition key definition.

Returns:

the partition key definition.

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKeyDefinition)

Sets the containers's partition key definition.

Parameters:

partitionKeyDefinition - the partition key definition.