com.azure.data.cosmos

Class CosmosContainerProperties

java.lang.Object

com.azure.data.cosmos.JsonSerializable

com.azure.data.cosmos.Resource

com.azure.data.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	conflictResolutionPolicy() Gets the conflictResolutionPolicy that is used for resolving conflicting writes on documents in different regions, in a collection in the Azure Cosmos DB service.
CosmosContainerProperties	conflictResolutionPolicy(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.
IndexingPolicy	indexingPolicy() Gets the container's indexing policy.
CosmosContainerProperties	indexingPolicy(IndexingPolicy indexingPolicy) Sets the container's indexing policy
PartitionKeyDefinition	partitionKeyDefinition() Gets the containers's partition key definition.
CosmosContainerProperties	partitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) Sets the containers's partition key definition.
UniqueKeyPolicy	uniqueKeyPolicy() Gets the containers unique key policy
CosmosContainerProperties	uniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) Sets the Containers unique key policy

Methods inherited from class com.azure.data.cosmos.Resource

etag, id, id, resourceId, resourceId, selfLink, timestamp

Methods inherited from class com.azure.data.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

indexingPolicy

public IndexingPolicy indexingPolicy()

Gets the container's indexing policy.

Returns:

the indexing policy.

indexingPolicy

public CosmosContainerProperties indexingPolicy(IndexingPolicy indexingPolicy)

Sets the container's indexing policy

Parameters:

indexingPolicy - IndexingPolicy the indexing policy

Returns:

the CosmosContainerProperties.

uniqueKeyPolicy

public UniqueKeyPolicy uniqueKeyPolicy()

Gets the containers unique key policy

Returns:

the unique key policy

uniqueKeyPolicy

public CosmosContainerProperties uniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy)

Sets the Containers unique key policy

Parameters:

uniqueKeyPolicy - the unique key policy

Returns:

the CosmosContainerProperties.

partitionKeyDefinition

public PartitionKeyDefinition partitionKeyDefinition()

Gets the containers's partition key definition.

Returns:

the partition key definition.

partitionKeyDefinition

public CosmosContainerProperties partitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition)

Sets the containers's partition key definition.

Parameters:

partitionKeyDefinition - the partition key definition.

Returns:

the CosmosContainerProperties.

conflictResolutionPolicy

public ConflictResolutionPolicy conflictResolutionPolicy()

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

conflictResolutionPolicy

public CosmosContainerProperties conflictResolutionPolicy(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.