com.microsoft.azure.cosmosdb

Class DocumentCollection

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmosdb.DocumentCollection

All Implemented Interfaces:

Serializable

public final class DocumentCollection
extends Resource

Represents a document collection in the Azure Cosmos DB database service. A collection is a named logical container for documents.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentCollection() Initialize a document collection object.
DocumentCollection(org.json.JSONObject jsonObject) Initialize a document collection object from json object.
DocumentCollection(String jsonString) Initialize a document collection object from json string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getConflictsLink() Gets the self-link for conflicts in a collection.
Integer	getDefaultTimeToLive() Gets the collection's default time-to-live value.
String	getDocumentsLink() Gets the self-link for documents in a collection.
IndexingPolicy	getIndexingPolicy() Gets the indexing policy.
PartitionKeyDefinition	getPartitionKey() Gets the collection's partition key definition.
String	getStoredProceduresLink() Gets the self-link for stored procedures in a collection.
String	getTriggersLink() Gets the self-link for triggers in a collection.
String	getUserDefinedFunctionsLink() Gets the self-link for user defined functions in a collection.
int	hashCode()
void	setDefaultTimeToLive(Integer timeToLive) Sets the collection's default time-to-live value.
void	setIndexingPolicy(IndexingPolicy indexingPolicy) Sets the indexing policy.
void	setPartitionKey(PartitionKeyDefinition partitionKey) Sets the collection's partition key definition.

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, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentCollection

public DocumentCollection()

Initialize a document collection object.

DocumentCollection

public DocumentCollection(String jsonString)

Initialize a document collection object from json string.

Parameters:

jsonString - the json string that represents the document collection.

DocumentCollection

public DocumentCollection(org.json.JSONObject jsonObject)

Initialize a document collection object from json object.

Parameters:

jsonObject - the json object that represents the document collection.

Method Detail

getIndexingPolicy

public IndexingPolicy getIndexingPolicy()

Gets the indexing policy.

Returns:

the indexing policy.

setIndexingPolicy

public void setIndexingPolicy(IndexingPolicy indexingPolicy)

Sets the indexing policy.

Parameters:

indexingPolicy - the indexing policy.

getPartitionKey

public PartitionKeyDefinition getPartitionKey()

Gets the collection's partition key definition.

Returns:

the partition key definition.

setPartitionKey

public void setPartitionKey(PartitionKeyDefinition partitionKey)

Sets the collection's partition key definition.

Parameters:

partitionKey - the partition key definition.

getDefaultTimeToLive

public Integer getDefaultTimeToLive()

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

Returns:

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

setDefaultTimeToLive

public void setDefaultTimeToLive(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.

getDocumentsLink

public String getDocumentsLink()

Gets the self-link for documents in a collection.

Returns:

the document link.

getStoredProceduresLink

public String getStoredProceduresLink()

Gets the self-link for stored procedures in a collection.

Returns:

the stored procedures link.

getTriggersLink

public String getTriggersLink()

Gets the self-link for triggers in a collection.

Returns:

the trigger link.

getUserDefinedFunctionsLink

public String getUserDefinedFunctionsLink()

Gets the self-link for user defined functions in a collection.

Returns:

the user defined functions link.

getConflictsLink

public String getConflictsLink()

Gets the self-link for conflicts in a collection.

Returns:

the conflicts link.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object