com.azure.cosmos.CosmosContainerProperties Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos;
import com.azure.cosmos.implementation.Constants;
import com.azure.cosmos.implementation.DocumentCollection;
import com.azure.cosmos.implementation.ResourceResponse;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
/**
* 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.
*/
public class CosmosContainerProperties extends Resource {
private IndexingPolicy indexingPolicy;
private UniqueKeyPolicy uniqueKeyPolicy;
private PartitionKeyDefinition partitionKeyDefinition;
/**
* Constructor
*
* @param id id of the Container
* @param partitionKeyPath partition key path
*/
public CosmosContainerProperties(String id, String partitionKeyPath) {
super.setId(id);
PartitionKeyDefinition partitionKeyDef = new PartitionKeyDefinition();
ArrayList paths = new ArrayList<>();
paths.add(partitionKeyPath);
partitionKeyDef.setPaths(paths);
setPartitionKeyDefinition(partitionKeyDef);
}
/**
* Constructor
*
* @param id id of the container
* @param partitionKeyDefinition the {@link PartitionKeyDefinition}
*/
public CosmosContainerProperties(String id, PartitionKeyDefinition partitionKeyDefinition) {
super.setId(id);
setPartitionKeyDefinition(partitionKeyDefinition);
}
CosmosContainerProperties(String json) {
super(json);
}
// Converting document collection to CosmosContainerProperties
CosmosContainerProperties(DocumentCollection collection) {
super(collection.toJson());
}
static List getFromV2Results(List results) {
return results.stream().map(CosmosContainerProperties::new).collect(Collectors.toList());
}
/**
* Gets the container's indexing policy.
*
* @return the indexing policy.
*/
public IndexingPolicy getIndexingPolicy() {
if (this.indexingPolicy == null) {
if (super.has(Constants.Properties.INDEXING_POLICY)) {
this.indexingPolicy = super.getObject(Constants.Properties.INDEXING_POLICY, IndexingPolicy.class);
} else {
this.indexingPolicy = new IndexingPolicy();
}
}
return this.indexingPolicy;
}
/**
* Sets the container's indexing policy
*
* @param indexingPolicy {@link IndexingPolicy} the indexing policy
* @return the CosmosContainerProperties.
* @throws IllegalArgumentException the cosmos client exception
*/
public CosmosContainerProperties setIndexingPolicy(IndexingPolicy indexingPolicy) {
if (indexingPolicy == null) {
throw new IllegalArgumentException("IndexingPolicy cannot be null.");
}
this.indexingPolicy = indexingPolicy;
super.set(Constants.Properties.INDEXING_POLICY, indexingPolicy);
return this;
}
/**
* Gets the containers unique key policy
*
* @return the unique key policy
*/
public UniqueKeyPolicy getUniqueKeyPolicy() {
// Thread safe lazy initialization for case when collection is cached (and is basically readonly).
if (this.uniqueKeyPolicy == null) {
this.uniqueKeyPolicy = super.getObject(Constants.Properties.UNIQUE_KEY_POLICY, UniqueKeyPolicy.class);
if (this.uniqueKeyPolicy == null) {
this.uniqueKeyPolicy = new UniqueKeyPolicy();
}
}
return this.uniqueKeyPolicy;
}
/**
* Sets the Containers unique key policy
*
* @param uniqueKeyPolicy the unique key policy
* @return the CosmosContainerProperties.
* @throws IllegalArgumentException the cosmos client exception
*/
public CosmosContainerProperties setUniqueKeyPolicy(UniqueKeyPolicy uniqueKeyPolicy) {
if (uniqueKeyPolicy == null) {
throw new IllegalArgumentException("uniqueKeyPolicy cannot be null.");
}
this.uniqueKeyPolicy = uniqueKeyPolicy;
super.set(Constants.Properties.UNIQUE_KEY_POLICY, uniqueKeyPolicy);
return this;
}
/**
* Gets the containers's partition key definition.
*
* @return the partition key definition.
*/
public PartitionKeyDefinition getPartitionKeyDefinition() {
if (this.partitionKeyDefinition == null) {
if (super.has(Constants.Properties.PARTITION_KEY)) {
this.partitionKeyDefinition = super.getObject(Constants.Properties.PARTITION_KEY,
PartitionKeyDefinition.class);
} else {
this.partitionKeyDefinition = new PartitionKeyDefinition();
}
}
return this.partitionKeyDefinition;
}
/**
* Sets the containers's partition key definition.
*
* @param partitionKeyDefinition the partition key definition.
* @return the CosmosContainerProperties.
* @throws IllegalArgumentException the cosmos client exception
*/
public CosmosContainerProperties setPartitionKeyDefinition(PartitionKeyDefinition partitionKeyDefinition) {
if (partitionKeyDefinition == null) {
throw new IllegalArgumentException(
"partitionKeyDefinition cannot be null.");
}
this.partitionKeyDefinition = partitionKeyDefinition;
return this;
}
/**
* Gets the conflictResolutionPolicy that is used for resolving conflicting writes
* on documents in different regions, in a collection in the Azure Cosmos DB service.
*
* @return ConflictResolutionPolicy
*/
public ConflictResolutionPolicy getConflictResolutionPolicy() {
return super.getObject(Constants.Properties.CONFLICT_RESOLUTION_POLICY, ConflictResolutionPolicy.class);
}
/**
* Sets the conflictResolutionPolicy that is used for resolving conflicting writes
* on documents in different regions, in a collection in the Azure Cosmos DB service.
*
* @param value ConflictResolutionPolicy to be used.
* @return the CosmosContainerProperties.
* @throws IllegalArgumentException the cosmos client exception
*/
public CosmosContainerProperties setConflictResolutionPolicy(ConflictResolutionPolicy value) {
if (value == null) {
throw new IllegalArgumentException(
"CONFLICT_RESOLUTION_POLICY cannot be null.");
}
super.set(Constants.Properties.CONFLICT_RESOLUTION_POLICY, value);
return this;
}
/**
* Gets the collection's default time-to-live value.
*
* @return the default time-to-live value in seconds.
*/
public Integer getDefaultTimeToLiveInSeconds() {
if (super.has(Constants.Properties.DEFAULT_TTL)) {
return super.getInt(Constants.Properties.DEFAULT_TTL);
}
return null;
}
/**
* 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.
*
* @param timeToLive the default time-to-live value in seconds.
*/
public void setDefaultTimeToLiveInSeconds(Integer timeToLive) {
// a "null" value is represented as a missing element on the wire.
// setting timeToLive to null should remove the property from the property bag.
if (timeToLive != null) {
super.set(Constants.Properties.DEFAULT_TTL, timeToLive);
} else if (super.has(Constants.Properties.DEFAULT_TTL)) {
super.remove(Constants.Properties.DEFAULT_TTL);
}
}
DocumentCollection getV2Collection() {
DocumentCollection collection = new DocumentCollection(this.toJson());
collection.setPartitionKey(this.getPartitionKeyDefinition());
collection.setIndexingPolicy(this.getIndexingPolicy());
return collection;
}
}